Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Anchor
imicode
imicode
Immunization Medication Information code

XPath:section/entry/substanceAdministration/consumable/manufacturedProduct/manufacturedMaterial/code
Purpose:Provides information about the immunization substance in a combined form, which includes its ingredients, strengths, and dose.

The code element must:

  • be present

  • contain code and codeSystem attributes

    AttributeValuePurpose

    code

    Must include an alphanumeric string of any length

    Identifies the medical substance used for the immunization

    codeSystem

    Must include a numeric string of any length in the following format: 2.16.840.1.1113883113883.X.XX

    Identifies the coding system used to translate the identifier provided in the code attribute
    Note

    displayName and codeSystemName are not required for processing.

    Note

    For accurate processing, we except to see code with code and codeSystem attributes, as documented above. However <code nullFlavor="UNK"/> or <code nullFlavor="OTH"/> is acceptable.

    If code is populated with nullFlavor="OTH", a child element of translation must be present and contain code and codeSystem attributes. Clinical Data Spaces will process the information provided here instead.

Code Block
languagexml
titleCode Example of Immunization Medication Information code
collapsetrue
<section> 
	<templateID root="2.16.840.1.113883.10.20.22.2.2"/> 
	<entry typeCode="DRIV">	
		<substanceAdministration classCode="SBADM" moodCode="EVN" negationInd="false">
			<templateId root="2.16.840.1.113883.10.20.22.4.52"/>
			<consumable>
				<manufacturedProduct>
					<templateId root="2.16.840.1.113883.10.20.22.4.54"/>
					<manufacturedMaterial>
						<code code="88" codeSystem="2.16.840.1.113883.6.59" displayName="Influenza virus vaccine" codeSystemName="CVX">
									<originalText>Influenza virus vaccine</originalText>
									<translation code="111" displayName="influenza, live, intranasal" codeSystemName="CVX" codeSystem="2.16.840.1.113883.6.59"/>
						</code>
					</manufacturedMaterial>
				</manufacturedProduct>
			</consumable>
		</substanceAdministration>
	</entry>
</section>
Warning

Processing of the code element will fail if it does not contain correctly populated code AND codeSystem attributes.

...

Anchor
iaroute
iaroute
Immunization Activity routeCode

XPath:section/entry/substanceAdministration/routeCode
Purpose:

Specifies how the immunization was administered (for example, intramuscular, orally etc.)

If present, the routeCode element must:

contain code AND codeSystem attributes:

AttributeValuePurpose

code

Must include an alphanumeric string of any length

Identifies how the immunization was administered

codeSystem

Must include a numeric string of any length in the following format: 2.16.840.1.1113883113883.X.XX

Identifies the coding system used to translate the identifier provided in the code attribute
Note

displayName and codeSystemName are not required for processing

Note

For accurate processing, we except to see code with code and codeSystem attributes, as documented above. However <code nullFlavor="UNK"/> or <code nullFlavor="OTH"/> is acceptable.

If code is populated with nullFlavor="OTH", a child element of translation must be present and contain code and codeSystem attributes. Clinical Data Spaces will process the information provided here instead.

  

Code Block
languagexml
titleCode Example of Immunization Activity routeCode
collapsetrue
<entry typeCode="DRIV">	
		<substanceAdministration classCode="SBADM" moodCode="EVN" negationInd="false">
			<templateId root="2.16.840.1.113883.10.20.22.4.52"/>
			<routeCode code="IM" codeSystem="2.16.840.1.113883.5.112" codeSystem=RouteOfAdministration" displayName="Intramuscular injection"/>
		</substanceAdministration>
</entry>

  

Warning

Processing of the routeCode element will fail if it does not contain correctly populated code and codeSystem attributes.

...

Anchor
iaapproach
iaapproach
Immunization Activity approachSiteCode

XPath:section/entry/substanceAdministration/approachSiteCode
Purpose:

Specifies where the immunization was administered (for example, where on the body the intramuscular injection was administered - leg, arm etc.)

If present, the approachSiteCode element must:

contain code AND codeSystem attributes:

AttributeValuePurpose

code

Must include an alphanumeric string of any length

Identifies where the immunization was administered

codeSystem

Must include a numeric string of any length in the following format: 2.16.840.1.1113883113883.X.XX

Identifies the coding system used to translate the identifier provided in the code attribute
Note

displayName and codeSystemName are not required for processing.

Note

For accurate processing, we except to see code with code and codeSystem attributes, as documented above. However <code nullFlavor="UNK"/> or <code nullFlavor="OTH"/> is acceptable.

If code is populated with nullFlavor="OTH", a child element of translation must be present and contain code and codeSystem attributes. Clinical Data Spaces will process the information provided here instead.

Code Block
languagexml
titleCode Example of Immunization Activity approachSiteCode
collapsetrue
 <entry typeCode="DRIV">	
		<substanceAdministration classCode="SBADM" moodCode="EVN" negationInd="false">
			<templateId root="2.16.840.1.113883.10.20.22.4.52"/>
<!----NEED THIS EXAMPLE--->
		</substanceAdministration>
</entry>
Warning

Processing of the approachSiteCode element will fail if it does not contain correctly populated code and codeSystem attributes.

...

Anchor
iaperformer
iaperformer
Immunization Activity performer

XPath:section/entry/substanceAdministration/performer
Purpose:Specifies the unique identifier of the person administering the immunization.
If an author element is present, it must:
  • have a child element of assignedEntity, which must
  • have a child element of id, which must
  • contain a root attribute and optionally contain an extension attribute

    AttributeValuePurpose
    root

    Must include an alphanumeric string in an OID (object identifier) or UUID (universally unique identifier) format. 

    For example, OID: 2.16.840.1.1113883113883.x.xx.x  or  UUID: 53459040-b1b4-49ed-ae1f-a52c8c502df4

    Uniquely identifies the author of the current medications entry

    extension

    Is optional and can include an alphanumeric string of any length

    Uniquely identifies the author of the current medications entry

Code Block
languagexml
titleCode Example of Immunization Activity performer
collapsetrue
<entry typeCode="DRIV">	
		<substanceAdministration classCode="SBADM" moodCode="EVN" negationInd="false">
			<templateId root="2.16.840.1.113883.10.20.22.4.52"/>
			<performer>
            	<assignedEntity>
                	<id extension="56789" root="2.16.840.1.113883.19.5"/>
            	</assignedEntity>
        </performer>
		</substanceAdministration>
</entry>
Warning

The performer element and its contents will be ignored if the id element does not contain a root attribute. Information provided within the performer element in the document header will be processed instead.

...

Anchor
ircode
ircode
Immunization Refusal code

XPath:section/entry/substanceAdministration/entryRelationship/observation/code
Purpose:

Specifies why a patient declined an immunization

If present, the code element must:
  • be contained within an entryRelationship element with a typeCode attribute of "RSON", which has a templateId of 2.16.840.113883.10.20.22.4.53
  • have a parent element of observation
  • contain code AND codeSystem attributes
AttributeValuePurpose

code

Must include an alphanumeric string of any length

Identifies the reason for a patient declining an immunization

codeSystem

Must include a numeric string of any length in the following format: 2.16.840.1.1113883113883.X.XX

Identifies the coding system used to translate the identifier provided in the code attribute
Note

displayName and codeSystemName are not required for processing.

Code Block
languagexml
titleCode Example of Immunization Refusal code
collapsetrue
<entry typeCode="DRIV">	
		<substanceAdministration classCode="SBADM" moodCode="EVN" negationInd="false">
			<templateId root="2.16.840.1.113883.10.20.22.4.52"/>
				<entryRelationship typeCode="RSON">
					<observation classCode="OBS" moodCode="EVN">
						<templateId root="2.16.840.113883.10.20.22.4.53"/>
						<code displayName="Patient Objection" code="PATOBJ" codeSystemName="HL7 ActNoImmunizationReason" codeSystem="2.16.840.113883.11.19725"/>
					</observation>
				</entryRelationship>
		</substanceAdministration>
</entry> 
Warning

Processing of the code element will fail if it does not contain correctly populated code and codeSystem attributes.

...

Anchor
iindvalue
iindvalue
Immunization Indication value

XPath:section/entry/substanceAdministration/entryRelationship/observation/value
Purpose:

Specifies the reason and/or rationale for the administration of the immunization

If present, the value element must:
  • be contained within an entryRelationship element with a typeCode attribute of "RSON", which has a templateId of: 2.16.840.1.113883.10.20.22.4.19
  • have a parent element of observation
  • contain xsi:type, code, and codeSystem attributes

    AttributeValuePurpose
    xsi:typeCDIndicates that the value element is providing code and codeSystem information
    code

    Must include an alphanumeric string of any length.

    Identifies the specific reason and/or rationale for the administration of the immunization
    codeSystemMust include an alphanumeric string of any length, but typically in the following format: 2.16.840.1.1113883113883.X.XX.X.XIdentifies the coding system used to translate the identifier provided in the code attribute
    Note

    displayName and codeSystemName are not required for processing

    Note

    For accurate processing, we except to see code with code and codeSystem attributes, as documented above. However <value nullFlavor="UNK"/> or <value nullFlavor="OTH"/> is acceptable.

    If value is populated with nullFlavor="OTH", a child element of translation must be present and contain code and codeSystem attributes. Clinical Data Spaces will process the information provided here instead.

Code Block
languagexml
titleCode Example of Immunization Indication value
collapsetrue
<entry typeCode="DRIV">	
		<substanceAdministration classCode="SBADM" moodCode="EVN" negationInd="false">
			<templateId root="2.16.840.1.113883.10.20.22.4.52"/>
				<entryRelationship typeCode="RSON">
					<observation classCode="OBS" moodCode="EVN">
						<templateId root="2.16.840.113883.10.20.22.4.19"/>
						<value nullFlavor="UNK"/> 
					</observation>
				</entryRelationship>
		</substanceAdministration>
</entry>
Warning

Processing of the value element will fail if it does not contain correctly populated xsi:type, code and codeSystem attributes.

...