International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPS Immunization

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.15--20170308000000 Version: 1.0
Draft as of 2017-03-08 Computable Name: IPSImmunization
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.15 (use: OFFICIAL)

An Immunization entry describes immunization substance administrations that have actually occurred. 

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..*CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeFixed Value: SBADM
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.15
... code S1..1CDBinding: ActSubstanceAdministrationImmunizationCode (required): ActSubstanceAdministrationImmunizationCode

... statusCode S1..1CS
.... code 0..1stringFixed Value: completed
... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... consumable S1..1Element
... author S0..*Author

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceAdministration.coderequiredActSubstanceAdministrationImmunizationCode
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..*CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.15
... code S1..1CDBinding: ActSubstanceAdministrationImmunizationCode (required): ActSubstanceAdministrationImmunizationCode

... statusCode S1..1CSBinding: ActStatus (required)
.... code 0..1stringFixed Value: completed
... effectiveTime 1..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... consumable S1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... author S0..*Author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.coderequiredActSubstanceAdministrationImmunizationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..*CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeFixed Value: EVN
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.15
..... extension 0..1string
... id 0..*II
... code S1..1CDBinding: ActSubstanceAdministrationImmunizationCode (required): ActSubstanceAdministrationImmunizationCode

... negationInd 0..1boolean
... text 0..1ED
... statusCode S1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: completed
.... 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_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CD​Binding: http://terminology.hl7.org/ValueSet/v3-ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable S1..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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..*Performer2
... author S0..*Author
... informant 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship C0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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
... reference 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.templateId:primary.nullFlavorrequiredNullFlavor
SubstanceAdministration.coderequiredActSubstanceAdministrationImmunizationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensible​http://terminology.hl7.org/ValueSet/v3-ActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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

This structure is derived from CDAR2.SubstanceAdministration

Summary

Mandatory: 8 elements
Must-Support: 5 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element SubstanceAdministration.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.SubstanceAdministration

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..*CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeFixed Value: SBADM
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.15
... code S1..1CDBinding: ActSubstanceAdministrationImmunizationCode (required): ActSubstanceAdministrationImmunizationCode

... statusCode S1..1CS
.... code 0..1stringFixed Value: completed
... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... consumable S1..1Element
... author S0..*Author

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceAdministration.coderequiredActSubstanceAdministrationImmunizationCode

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..*CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeFixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.15
... code S1..1CDBinding: ActSubstanceAdministrationImmunizationCode (required): ActSubstanceAdministrationImmunizationCode

... statusCode S1..1CSBinding: ActStatus (required)
.... code 0..1stringFixed Value: completed
... effectiveTime 1..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... consumable S1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... author S0..*Author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.coderequiredActSubstanceAdministrationImmunizationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.consumable.typeCoderequiredFixed Value: CSM

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 0..*CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1codeFixed Value: EVN
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary S1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringFixed Value: 2.16.840.1.113883.10.22.4.15
..... extension 0..1string
... id 0..*II
... code S1..1CDBinding: ActSubstanceAdministrationImmunizationCode (required): ActSubstanceAdministrationImmunizationCode

... negationInd 0..1boolean
... text 0..1ED
... statusCode S1..1CSBinding: ActStatus (required)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 0..1stringFixed Value: completed
.... 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_INT
... routeCode 0..1CEBinding: RouteOfAdministration (extensible)
... approachSiteCode 0..*CD​Binding: http://terminology.hl7.org/ValueSet/v3-ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable S1..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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..*Performer2
... author S0..*Author
... informant 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... participant 0..*Participant2
... entryRelationship C0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... 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
... reference 0..*Element
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
SubstanceAdministration.templateId:primary.nullFlavorrequiredNullFlavor
SubstanceAdministration.coderequiredActSubstanceAdministrationImmunizationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.statusCode.nullFlavorrequiredNullFlavor
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensible​http://terminology.hl7.org/ValueSet/v3-ActSite
SubstanceAdministration.administrationUnitCodeextensibleAdministrableDrugForm
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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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

This structure is derived from CDAR2.SubstanceAdministration

Summary

Mandatory: 8 elements
Must-Support: 5 elements
Fixed Value: 4 elements

Slices

This structure defines the following Slices:

  • The element SubstanceAdministration.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel, Schematron