Name Flags Card. Type Description & Constraints SubstanceAdministration C 1..1 SubstanceAdministration XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, <a href="http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-InfrastructureRoot.html" title="When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.">typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, repeatNumber, routeCode, approachSiteCode, doseQuantity, rateQuantity, maxDoseQuantity, administrationUnitCode, <a href="http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-SubstanceAdministration.html" title="The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.">consumable, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1 Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value Slices for templateId 1..* II Slice: Unordered, Open by value:root templateId:planned-immunization-activity 1..1 II @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.120 @extension 0..0 @classCode 1..1 cs @moodCode 1..1 cs Binding: Planned moodCode (SubstanceAdministration/Supply) (required) id 1..* II text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative statusCode 1..1 CS @code 1..1 cs Fixed Value: active effectiveTime 1..1 SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur. repeatNumber 0..1 IVL_INT In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. routeCode C 0..1 CE Binding: SPL Drug Route of Administration Terminology (required) should-translation: SHOULD contain translation translation 0..* CD Binding: Medication Route (required) approachSiteCode 0..* CD Binding: Body Site Value Set (required) doseQuantity C 0..1 IVL_PQ should-unit: SHOULD contain @unit @unit 0..1 cs NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units Binding: UnitsOfMeasureCaseSensitive (required) consumable 1..1 InfrastructureRoot manufacturedProduct 1..1 ImmunizationMedicationInformation Base for all types and resources performer 0..* Performer2 The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer. author 0..* AuthorParticipation The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity. Slices for entryRelationship 0..* EntryRelationship The following entryRelationship captures any instructions associated with the planned immunization activity. Slice: Unordered, Open by profile:observation, profile:act entryRelationship:priorityPreference 0..* EntryRelationship The following entryRelationship represents the priority that a patient or a provider places on the immunization activity. @typeCode 1..1 cs Fixed Value: REFR observation 1..1 PriorityPreference Base for all types and resources entryRelationship:indication 0..* EntryRelationship The following entryRelationship represents the indication for the immunization activity. @typeCode 1..1 cs Fixed Value: RSON observation 1..1 Indication Base for all types and resources entryRelationship:instruction 0..* EntryRelationship @typeCode 1..1 cs Fixed Value: SUBJ act 1..1 Instruction Base for all types and resources Slices for precondition 0..* Precondition Slice: Unordered, Open by profile:criterion precondition:pronditionForSubstanceAdmin 0..* Precondition @typeCode 1..1 cs criterion 1..1 PreconditionforSubstanceAdministration Base for all types and resources Documentation for this format
HL7 International - Structured Documents
This template represents planned immunizations. Planned Immunization Activity is very similar to Planned Medication Activity with some key differences, for example, the drug code system is constrained to CVX codes. The priority of the immunization activity to the patient and provider is communicated through Priority Preference. The effectiveTime indicates the time when the immunization activity is intended to take place and authorTime indicates when the documentation of the plan occurred.
Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Identifies the type as an HL7 Registered model
A character string as a unique identifier within the scope of the identifier root.
When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
SHALL contain exactly one [1..1] @classCode="SBADM" (CONF:1098-32091).
SHALL contain exactly one [1..1] @moodCode, which SHALL be selected from ValueSet Planned moodCode (SubstanceAdministration/Supply) urn:oid:2.16.840.1.113883.11.20.9.24 STATIC 2014-09-01 (CONF:1098-32097).
SHALL contain at least one [1..*] id (CONF:1098-32100).
SHOULD reference the portion of section narrative text corresponding to this entry
Indicates whether the raw byte data is compressed, and what compression algorithm was used.
The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
For character based information the language property specifies the human language of the text.
Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
value.exists() implies value.startsWith('#')
An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
SHALL contain exactly one [1..1] statusCode (CONF:1098-32101).
The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
This statusCode SHALL contain exactly one [1..1] @code="active" Active (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-32102).
Specifies the code system that defines the code.
If applicable, a version descriptor defined specifically for the given code system.
A name or title for the code, under which the sending system shows the code value to its users.
The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
The text or phrase used as the basis for the coding.
Specifies additional codes that increase the specificity of the the primary code.
A set of other concept descriptors that translate this concept descriptor into other code systems.
The effectiveTime in a planned immunization activity represents the time that the immunization activity should occur.
SHALL contain exactly one [1..1] effectiveTime (CONF:1098-32103).
In a Planned Immunization Activity, repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times.
MAY contain zero or one [0..1] repeatNumber (CONF:1098-32126).
MAY contain zero or one [0..1] routeCode, which SHALL be selected from ValueSet SPL Drug Route of Administration Terminology urn:oid:2.16.840.1.113883.3.88.12.3221.8.7 DYNAMIC (CONF:1098-32127).
The routeCode, if present, SHOULD contain zero or more [0..*] translation, which SHALL be selected from ValueSet Medication Route urn:oid:2.16.840.1.113762.1.4.1099.12 DYNAMIC (CONF:1098-32951).
MAY contain zero or more [0..*] approachSiteCode, which SHALL be selected from ValueSet Body Site Value Set urn:oid:2.16.840.1.113883.3.88.12.3221.8.9 DYNAMIC (CONF:1098-32128).
MAY contain zero or one [0..1] doseQuantity (CONF:1098-32129).
NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].
The doseQuantity, if present, SHOULD contain zero or one [0..1] @unit, which SHALL be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC (CONF:1098-32130).
The magnitude of the quantity measured in terms of the unit.
An alternative representation of the same physical quantity expressed in a different unit, of a different unit code system and possibly with a different value.
A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.
The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.
The consumable participation is used to bring in the LabeledDrug or Material entity that describes the administered substance. The LabeledDrug class, which is an Entity class playing the Role of Manufactured Product, identifies the drug that is consumed in the substance administration. The medication is identified by means of the LabeledDrug.code or the LabeledDrug.name. The Material entity is used to identify non-drug administered substances such as vaccines and blood products.
SHALL contain exactly one [1..1] consumable (CONF:1098-32131).
This consumable SHALL contain exactly one [1..1] Immunization Medication Information (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09) (CONF:1098-32132).
manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
(manufacturedLabeledDrug | manufacturedMaterial).count() = 1
The clinician who is expected to perform the planned immunization activity could be identified using substanceAdministration/performer.
MAY contain zero or more [0..*] performer (CONF:1098-32104).
The author in a planned immunization activity represents the clinician who is requesting or planning the immunization activity.
MAY contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-32105).
The following entryRelationship captures any instructions associated with the planned immunization activity.
The following entryRelationship represents the priority that a patient or a provider places on the immunization activity.
MAY contain zero or more [0..*] entryRelationship (CONF:1098-32108) such that it
SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32109).
The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:1098-32110).
The following entryRelationship represents the indication for the immunization activity.
MAY contain zero or more [0..*] entryRelationship (CONF:1098-32114) such that it
SHALL contain exactly one [1..1] @typeCode="RSON" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32115).
MAY contain zero or more [0..*] entryRelationship (CONF:1098-32117) such that it
SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32118).
MAY contain zero or more [0..*] precondition (CONF:1098-32123) such that it
SHALL contain exactly one [1..1] @typeCode="PRCN" Precondition (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:1098-32124).
SHALL contain exactly one [1..1] Precondition for Substance Administration (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.25:2014-06-09) (CONF:1098-32125).