Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions

Resource Profile: Immunization Activity

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.52 Version: 2.2
Active as of 2022-05-13 Computable Name: ImmunizationActivity
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01

An Immunization Activity describes immunization substance administrations that have actually occurred or are intended to occur. Immunization Activities in “INT” mood are reflections of immunizations a clinician intends a patient to receive. Immunization Activities in “EVN” mood reflect immunizations actually received. An Immunization Activity is very similar to a Medication Activity with some key differentiators. The drug code system is constrained to CVX codes. Administration timing is less complex. Patient refusal reasons should be captured. All vaccines administered should be fully documented in the patient’s permanent medical record. Healthcare providers who administer vaccines covered by the National Childhood Vaccine Injury Act are required to ensure that the permanent medical record of the recipient indicates:

  1. Date of administration
  2. Vaccine manufacturer
  3. Vaccine lot number
  4. Name and title of the person who administered the vaccine and the address of the clinic or facility where the permanent record will reside
  5. Vaccine information statement (VIS) a. Date printed on the VIS b. Date VIS given to patient or parent/guardian.

This information should be included in an Immunization Activity when available. (Reference: [https://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/c/vis-instruct.pdf])

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CDAR2.SubstanceAdministration

Summary

Mandatory: 12 elements (20 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element SubstanceAdministration.templateId is sliced based on the values of value:root, value:extension
  • The element SubstanceAdministration.participant is sliced based on the values of value:typeCode, profile:participantRole
  • The element SubstanceAdministration.entryRelationship is sliced based on the values of profile:act, profile:observation, profile:supply
  • The element SubstanceAdministration.precondition is sliced based on the value of profile:criterion

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1code
... moodCode 1..1codeBinding: MoodCodeEvnInt (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.52
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 0..1CDSubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
... negationInd 1..1booleanUse negationInd="true" to indicate that the immunization was not given.
... statusCode 1..1CS
.... code 1..1stringBinding: ActStatus (required)
... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..1CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... manufacturedProduct 1..1ImmunizationMedicationInformation
... performer 0..1Performer2
... author 0..*AuthorParticipation
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, profile:participantRole
.... participant:drugVehicle 0..*Participant2
..... typeCode 1..1codeRequired Pattern: CSM
..... participantRole 1..1DrugVehicle
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:act, profile:observation, profile:supply
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1Indication
.... entryRelationship:instruction 0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... act 1..1Instruction
.... entryRelationship:medSupplyOrder 0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... supply 1..1MedicationSupplyOrder
.... entryRelationship:medDispense 0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... supply 1..1MedicationDispense
.... entryRelationship:reactionObs 0..1Element
..... typeCode 1..1codeRequired Pattern: CAUS
..... observation 1..1ReactionObservation
.... entryRelationship:immunizationRefusal 0..1Element
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1ImmunizationRefusalReason
.... entryRelationship:substanceAdmin 0..*ElementThe following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... sequenceNumber 0..1INT
..... act 1..1SubstanceAdministeredAct
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:substanceAdmin 0..*Precondition
..... typeCode 1..1codeRequired Pattern: PRCN
..... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeBinding: MoodCodeEvnInt (required)
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.52
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 1..*II
... code 0..1CDSubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
Binding: http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode (extensible)
... negationInd 1..1booleanUse negationInd="true" to indicate that the immunization was not given.
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringBinding: ActStatus (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1string
.... codeSystem 0..1string
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..1CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
.... value 0..1decimal
.... low 0..1PQ
.... high 0..1PQ
.... width 0..1PQ
.... center 0..1PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ImmunizationMedicationInformation
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..1Performer2
... author 0..*AuthorParticipation
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, profile:participantRole
.... participant:drugVehicle 0..*Participant2
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: CSM
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1DrugVehicle
... Slices for entryRelationship I0..*ElementSlice: Unordered, Open by profile:act, profile:observation, profile:supply
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:indication I0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1Indication
.... entryRelationship:instruction I0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1Instruction
.... entryRelationship:medSupplyOrder I0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... supply 1..1MedicationSupplyOrder
.... entryRelationship:medDispense I0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... supply I1..1MedicationDispense
.... entryRelationship:reactionObs I0..1Element
..... typeCode 1..1codeRequired Pattern: CAUS
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1ReactionObservation
.... entryRelationship:immunizationRefusal I0..1Element
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1ImmunizationRefusalReason
.... entryRelationship:substanceAdmin I0..*ElementThe following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1SubstanceAdministeredAct
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:substanceAdmin 0..*Precondition
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ActRelationshipType (required)
Required Pattern: PRCN
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format

This structure is derived from CDAR2.SubstanceAdministration

Summary

Mandatory: 12 elements (20 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element SubstanceAdministration.templateId is sliced based on the values of value:root, value:extension
  • The element SubstanceAdministration.participant is sliced based on the values of value:typeCode, profile:participantRole
  • The element SubstanceAdministration.entryRelationship is sliced based on the values of profile:act, profile:observation, profile:supply
  • The element SubstanceAdministration.precondition is sliced based on the value of profile:criterion

Differential View

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1code
... moodCode 1..1codeBinding: MoodCodeEvnInt (required)
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.52
..... extension 1..1stringRequired Pattern: 2015-08-01
... code 0..1CDSubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
... negationInd 1..1booleanUse negationInd="true" to indicate that the immunization was not given.
... statusCode 1..1CS
.... code 1..1stringBinding: ActStatus (required)
... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..1CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... manufacturedProduct 1..1ImmunizationMedicationInformation
... performer 0..1Performer2
... author 0..*AuthorParticipation
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, profile:participantRole
.... participant:drugVehicle 0..*Participant2
..... typeCode 1..1codeRequired Pattern: CSM
..... participantRole 1..1DrugVehicle
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:act, profile:observation, profile:supply
.... entryRelationship:indication 0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1Indication
.... entryRelationship:instruction 0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... act 1..1Instruction
.... entryRelationship:medSupplyOrder 0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... supply 1..1MedicationSupplyOrder
.... entryRelationship:medDispense 0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... supply 1..1MedicationDispense
.... entryRelationship:reactionObs 0..1Element
..... typeCode 1..1codeRequired Pattern: CAUS
..... observation 1..1ReactionObservation
.... entryRelationship:immunizationRefusal 0..1Element
..... typeCode 1..1codeRequired Pattern: RSON
..... observation 1..1ImmunizationRefusalReason
.... entryRelationship:substanceAdmin 0..*ElementThe following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... sequenceNumber 0..1INT
..... act 1..1SubstanceAdministeredAct
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:substanceAdmin 0..*Precondition
..... typeCode 1..1codeRequired Pattern: PRCN
..... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministration
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeBinding: MoodCodeEvnInt (required)
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.52
..... extension 1..1stringRequired Pattern: 2015-08-01
... id 1..*II
... code 0..1CDSubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
Binding: http://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode (extensible)
... negationInd 1..1booleanUse negationInd="true" to indicate that the immunization was not given.
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringBinding: ActStatus (required)
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series.
... routeCode 0..1CEBinding: SPL Drug Route of Administration Terminology (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1string
.... codeSystem 0..1string
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CDBinding: Medication Route (required)
... approachSiteCode 0..1CDBinding: Body Site Value Set (required)
... doseQuantity 0..1IVL_PQ
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... unit 0..1codeBinding: UnitsOfMeasureCaseSensitive (required)
.... value 0..1decimal
.... low 0..1PQ
.... high 0..1PQ
.... width 0..1PQ
.... center 0..1PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrationUnitDoseForm (required)
... consumable 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ImmunizationMedicationInformation
... subject 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... specimen 0..*Specimen
... performer 0..1Performer2
... author 0..*AuthorParticipation
... informant 0..*Element
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, profile:participantRole
.... participant:drugVehicle 0..*Participant2
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: CSM
..... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1DrugVehicle
... Slices for entryRelationship I0..*ElementSlice: Unordered, Open by profile:act, profile:observation, profile:supply
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:indication I0..*Element
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1Indication
.... entryRelationship:instruction I0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1Instruction
.... entryRelationship:medSupplyOrder I0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... supply 1..1MedicationSupplyOrder
.... entryRelationship:medDispense I0..1Element
..... typeCode 1..1codeRequired Pattern: REFR
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... supply I1..1MedicationDispense
.... entryRelationship:reactionObs I0..1Element
..... typeCode 1..1codeRequired Pattern: CAUS
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1ReactionObservation
.... entryRelationship:immunizationRefusal I0..1Element
..... typeCode 1..1codeRequired Pattern: RSON
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1ImmunizationRefusalReason
.... entryRelationship:substanceAdmin I0..*ElementThe following entryRelationship is used to indicate a given immunization's order in a series. The nested Substance Administered Act identifies an administration in the series. The entryRelationship/sequenceNumber shows the order of this particular administration in that series.
..... typeCode 1..1codeRequired Pattern: COMP
..... inversionInd 1..1booleanRequired Pattern: true
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... act 1..1SubstanceAdministeredAct
... reference 0..*Element
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
.... precondition:substanceAdmin 0..*Precondition
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ActRelationshipType (required)
Required Pattern: PRCN
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... criterion 1..1PreconditionforSubstanceAdministration

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.moodCoderequiredMoodCodeEvnInt
SubstanceAdministration.templateId:primary.nullFlavorrequiredNullFlavor
SubstanceAdministration.codeextensiblehttp://terminology.hl7.org/ValueSet/v3-SubstanceAdministrationActCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.statusCode.coderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCoderequiredSPL Drug Route of Administration Terminology
SubstanceAdministration.routeCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.routeCode.translationrequiredMedicationRoute
SubstanceAdministration.approachSiteCoderequiredBodySiteValueSet
SubstanceAdministration.doseQuantity.nullFlavorrequiredNullFlavor
SubstanceAdministration.doseQuantity.unitrequiredUnitsOfMeasureCaseSensitive
SubstanceAdministration.administrationUnitCoderequiredAdministrationUnitDoseForm
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM
SubstanceAdministration.subject.typeCoderequiredFixed Value: SBJ
SubstanceAdministration.subject.contextControlCoderequiredFixed Value: OP
SubstanceAdministration.subject.awarenessCodeextensibleTargetAwareness
SubstanceAdministration.informant.typeCoderequiredFixed Value: INF
SubstanceAdministration.informant.contextControlCoderequiredFixed Value: OP
SubstanceAdministration.participant:drugVehicle.nullFlavorrequiredNullFlavor
SubstanceAdministration.participant:drugVehicle.typeCoderequiredPattern: CSM
SubstanceAdministration.participant:drugVehicle.contextControlCoderequiredFixed Value: OP
SubstanceAdministration.precondition:substanceAdmin.nullFlavorrequiredNullFlavor
SubstanceAdministration.precondition:substanceAdmin.typeCoderequiredPattern: PRCN

Constraints

IdGradePathDetailsRequirements
subst-er-1errorSubstanceAdministration.entryRelationshipOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:indicationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:instructionOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:medSupplyOrderOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:medDispenseOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
1098-9333errorSubstanceAdministration.entryRelationship:medDispense.supplyA supply act **SHALL** contain one product/Medication Information *OR* one product/Immunization Medication Information template (CONF:1098-9333).
:
subst-er-1errorSubstanceAdministration.entryRelationship:reactionObsOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:immunizationRefusalOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
subst-er-1errorSubstanceAdministration.entryRelationship:substanceAdminOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1