Consolidated CDA Release 2.2
2.2 - CI Build Unknown state code 'US'

Consolidated CDA Release 2.2 - Local Development build (v2.2). See the Directory of published versions

Resource Profile: Planned Immunization Activity

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.120 Version: 2.2
Active as of 2023-05-30 Computable Name: PlannedImmunizationActivity
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.120

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1code
... consumable 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
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 1..1CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1code
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... negationInd 0..1boolean
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... 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..*CDBinding: v3 Code System ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..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 0..*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.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensiblev3.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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceAdministration 1..1CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1code
... consumable 1..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: CSM
.... manufacturedProduct 1..1ManufacturedProduct

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
SubstanceAdministration.classCoderequiredFixed Value: SBADM
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 1..1CDAR2.SubstanceAdministrationBase for all types and resources
... classCode 1..1codeBinding: ActClass (required)
Fixed Value: SBADM
... moodCode 1..1code
... realmCode 0..*CS
... typeId 0..1II
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: ActSubstanceAdministrationCode (extensible)
... negationInd 0..1boolean
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... 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..*CDBinding: v3 Code System ActSite (extensible)
... doseQuantity 0..1IVL_PQ
... rateQuantity 0..1IVL_PQ
... maxDoseQuantity 0..1RTO_PQ_PQ
... administrationUnitCode 0..1CEBinding: AdministrableDrugForm (extensible)
... consumable 1..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 0..*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.codeextensibleActSubstanceAdministrationCode
SubstanceAdministration.statusCoderequiredActStatus
SubstanceAdministration.priorityCodeextensibleActPriority
SubstanceAdministration.routeCodeextensibleRouteOfAdministration
SubstanceAdministration.approachSiteCodeextensiblev3.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

 

Other representations of profile: CSV, Excel, Schematron