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: Non-Medicinal Supply Activity

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.50 Version: 2.2
Active as of 2022-05-13 Computable Name: NonMedicinalSupplyActivity
Other Identifiers: : urn:hl7ii:2.16.840.1.113883.10.20.22.4.50:2014-06-09

This template represents equipment supplied to the patient (e.g., pumps, inhalers, wheelchairs). Devices applied to, or placed in, the patient are represented with the Product Instance entry contained within a Procedure Activity Procedure (V2) (identifier: urn:hl7ii: 2.16.840.1.113883.10.20.22.4.14)

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2Supply

Summary

Mandatory: 8 elements (5 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Supply.templateId is sliced based on the values of value:root, value:extension
  • The element Supply.participant is sliced based on the values of value:typeCode, value:participantRole
  • The element Supply.entryRelationship is sliced based on the value of profile:act

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2Supply
... classCode 1..1codeRequired Pattern: SPLY
... 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.50
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringBinding: ActStatus (required)
... effectiveTime I0..1EIVL_TS1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
... quantity 0..1PQ
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, value:participantRole
.... participant:participant1 0..1Participant2
..... typeCode 1..1codeRequired Pattern: PRD
..... participantRole 1..1ProductInstance
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... act 1..1Instruction

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2Supply
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeBinding: MoodCodeEvnInt (required)
... realmCode 0..*CS
... 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.50
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... 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 I0..1EIVL_TS1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... 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..*Performer2
... author 0..*Author
... 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, value:participantRole
.... participant:participant1 0..1Participant2
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: PRD
..... 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..1ProductInstance
... Slices for entryRelationship I0..*ElementSlice: Unordered, Open by profile:act
.... 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: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
... reference 0..*Element
.... 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

This structure is derived from CDAR2Supply

Summary

Mandatory: 8 elements (5 nested mandatory elements)

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Supply.templateId is sliced based on the values of value:root, value:extension
  • The element Supply.participant is sliced based on the values of value:typeCode, value:participantRole
  • The element Supply.entryRelationship is sliced based on the value of profile:act

Differential View

This structure is derived from CDAR2Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2Supply
... classCode 1..1codeRequired Pattern: SPLY
... 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.50
..... extension 1..1stringRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1stringBinding: ActStatus (required)
... effectiveTime I0..1EIVL_TS1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
... quantity 0..1PQ
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, value:participantRole
.... participant:participant1 0..1Participant2
..... typeCode 1..1codeRequired Pattern: PRD
..... participantRole 1..1ProductInstance
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1Element
..... typeCode 1..1codeRequired Pattern: SUBJ
..... inversionInd 1..1booleanRequired Pattern: true
..... act 1..1Instruction

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2Supply
... classCode 1..1codeBinding: ActClassSupply (required)
Fixed Value: SPLY
... moodCode 1..1codeBinding: MoodCodeEvnInt (required)
... realmCode 0..*CS
... 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.50
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (extensible)
... 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 I0..1EIVL_TS1098-16867: The effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
... priorityCode 0..*CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1Element
.... typeCode 1..1codeBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... 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..*Performer2
... author 0..*Author
... 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, value:participantRole
.... participant:participant1 0..1Participant2
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... typeCode 1..1codeBinding: ParticipationType (required)
Required Pattern: PRD
..... 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..1ProductInstance
... Slices for entryRelationship I0..*ElementSlice: Unordered, Open by profile:act
.... 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: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
... reference 0..*Element
.... 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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredMoodCodeEvnInt
Supply.templateId:primary.nullFlavorrequiredNullFlavor
Supply.codeextensibleActCode
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredNullFlavor
Supply.statusCode.coderequiredActStatus
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
Supply.participant:participant1.nullFlavorrequiredNullFlavor
Supply.participant:participant1.typeCoderequiredPattern: PRD
Supply.participant:participant1.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePathDetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:
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
sup-er-1errorSupply.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