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: Medication Dispense

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.18 Version: 2.2
Active as of 2023-05-30 Computable Name: MedicationDispense
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2014-06-09

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.

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... realmCode 0..*CS
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 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: ParticipationTargetDirect (required)
Fixed Value: PRD
.... 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
Supply.classCoderequiredFixed Value: SPLY
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.informant.typeCoderequiredFixed Value: INF
Supply.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()
sup-er-1errorSupply.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 CDAR2Supply

Summary

Differential View

This structure is derived from CDAR2Supply

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyBase for all types and resources
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1code
... realmCode 0..*CS
... templateId 0..*II
... id 0..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... text 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..*
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 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: ParticipationTargetDirect (required)
Fixed Value: PRD
.... 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
Supply.classCoderequiredFixed Value: SPLY
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.priorityCodeextensibleActPriority
Supply.product.typeCoderequiredFixed Value: PRD
Supply.subject.typeCoderequiredFixed Value: SBJ
Supply.subject.contextControlCoderequiredFixed Value: OP
Supply.subject.awarenessCodeextensibleTargetAwareness
Supply.informant.typeCoderequiredFixed Value: INF
Supply.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()
sup-er-1errorSupply.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 CDAR2Supply

Summary

 

Other representations of profile: CSV, Excel, Schematron