Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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

Logical Model: Non-Medicinal Supply Activity

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity Version: 2.1
Draft as of 2023-09-29 Computable Name: NonMedicinalSupplyActivity
Other Identifiers: id: 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 (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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1cs
... moodCode 1..1csBinding: MoodCodeEvnInt (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.50
..... extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1csBinding: ActStatus (required)
... effectiveTime C0..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..1csFixed Value: PRD
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... typeCode 1..1csFixed Value: SUBJ
..... inversionInd 1..1blFixed Value: true
..... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.moodCoderequiredMoodCodeEvnInt
Supply.statusCode.coderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime C0..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..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredMoodCodeEvnInt
Supply.statusCoderequiredActStatus
Supply.statusCode.coderequiredActStatus
Supply.participant:participant1.typeCoderequiredFixed Value: PRD
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1stRequired 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..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: ActStatus (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime C0..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..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, value:participantRole
.... participant:participant1 0..1Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

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.nullFlavorrequiredNullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.nullFlavorrequiredNullFlavor
Supply.participant:participant1.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.contextControlCoderequiredFixed Value: OP
Supply.entryRelationship:instruction.nullFlavorrequiredNullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2Supply

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 3 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 CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1cs
... moodCode 1..1csBinding: MoodCodeEvnInt (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.50
..... extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CS
.... code 1..1csBinding: ActStatus (required)
... effectiveTime C0..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..1csFixed Value: PRD
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... typeCode 1..1csFixed Value: SUBJ
..... inversionInd 1..1blFixed Value: true
..... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.moodCoderequiredMoodCodeEvnInt
Supply.statusCode.coderequiredActStatus

Constraints

IdGradePath(s)DetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1stRequired Pattern: 2014-06-09
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime C0..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..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... act 1..1InstructionBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredMoodCodeEvnInt
Supply.statusCoderequiredActStatus
Supply.statusCode.coderequiredActStatus
Supply.participant:participant1.typeCoderequiredFixed Value: PRD
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply 1..1CDAR2SupplyXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, realmCode, typeId, templateId, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... realmCode 0..*CS
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1stRequired 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..1csBinding: NullFlavor (required)
.... @code 1..1csBinding: ActStatus (required)
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime C0..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..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1ManufacturedProduct
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode, value:participantRole
.... participant:participant1 0..1Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1blFixed Value: true
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 1..1InstructionBase for all types and resources
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply 0..1Supply
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

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.nullFlavorrequiredNullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.nullFlavorrequiredNullFlavor
Supply.participant:participant1.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.contextControlCoderequiredFixed Value: OP
Supply.entryRelationship:instruction.nullFlavorrequiredNullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
1098-16867warningSupply.effectiveTimeThe effectiveTime, if present, **SHOULD** contain zero or one [0..1] *high* (CONF:1098-16867).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2Supply

Summary

Mandatory: 7 elements (3 nested mandatory elements)
Fixed Value: 3 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

 

Other representations of profile: CSV, Excel