Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ 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: 4.0.0-ballot
Draft as of 2024-11-21 Computable Name: NonMedicinalSupplyActivity
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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 Template Content

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

This structure is derived from Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs
... @moodCode 1..1 cs Binding: MoodCodeEvnInt . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @nullFlavor 0..0
.... @code 1..1 cs Binding: VSAC 2.16.840.1.113883.1.11.15933 . (required)
... effectiveTime C 0..1 IVL_TS should-high: SHOULD contain high
... quantity 0..1 PQ
... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
.... participant:product 0..1 Participant2
..... @typeCode 1..1 cs Fixed Value: PRD
..... participantRole 1..1 ProductInstance Base for all types and resources
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1 EntryRelationship
..... @typeCode 1..1 cs Fixed Value: SUBJ
..... @inversionInd 1..1 bl Fixed Value: true
..... observation 1..1 InstructionObservation Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Supply.moodCoderequiredMoodCodeEvnInt .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18
Supply.statusCode.coderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933

Constraints

IdGradePath(s)DetailsRequirements
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-highwarningSupply.effectiveTimeSHOULD contain high
: high.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: MoodCodeEvnInt . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Binding: VSAC 2.16.840.1.113883.1.11.15933 . (required)
... effectiveTime C 0..1 IVL_TS should-high: SHOULD contain high
... quantity 0..1 PQ
... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
.... participant:product 0..1 Participant2
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: PRD
..... participantRole C 1..1 ProductInstance Base for all types and resources
role-choice: playingDevice and playingEntity are mutually exclusive
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1 EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 bl Fixed Value: true
..... observation C 1..1 InstructionObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Supply.classCoderequiredFixed Value: SPLY
http://terminology.hl7.org/ValueSet/v3-ActClassSupply
Supply.moodCoderequiredMoodCodeEvnInt .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18
Supply.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Supply.statusCode.coderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
Supply.participant:product.typeCoderequiredFixed Value: PRD
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorSupply.participant:product.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-highwarningSupply.effectiveTimeSHOULD contain high
: high.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:instruction.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: MoodCodeEvnInt . (required)
... id 1..* II
... code 0..1 CD Binding: v3 Code System ActCode (example)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Binding: VSAC 2.16.840.1.113883.1.11.15933 . (required)
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime C 0..1 IVL_TS should-high: SHOULD contain high
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
.... participant:product 0..1 Participant2
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: PRD
..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1 IVL_TS
..... awarenessCode 0..1 CE
..... participantRole C 1..1 ProductInstance Base for all types and resources
role-choice: playingDevice and playingEntity are mutually exclusive
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1 EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 bl Fixed Value: true
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation C 1..1 InstructionObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Supply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.templateId:non-medicinal-supply-activity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
http://terminology.hl7.org/ValueSet/v3-ActClassSupply
Supply.moodCoderequiredMoodCodeEvnInt .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18
Supply.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Supply.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Supply.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Supply.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Supply.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Supply.statusCode.coderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
Supply.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect
Supply.participant:product.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.participant:product.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.participant:product.typeCoderequiredFixed Value: PRD
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Supply.participant:product.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorSupply.participant:product.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-highwarningSupply.effectiveTimeSHOULD contain high
: high.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:instruction.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Supply

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Fixed: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Supply.templateId
  • The element 1 is sliced based on the value of Supply.participant
  • The element 1 is sliced based on the value of Supply.entryRelationship

Differential View

This structure is derived from Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs
... @moodCode 1..1 cs Binding: MoodCodeEvnInt . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS
.... @nullFlavor 0..0
.... @code 1..1 cs Binding: VSAC 2.16.840.1.113883.1.11.15933 . (required)
... effectiveTime C 0..1 IVL_TS should-high: SHOULD contain high
... quantity 0..1 PQ
... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
.... participant:product 0..1 Participant2
..... @typeCode 1..1 cs Fixed Value: PRD
..... participantRole 1..1 ProductInstance Base for all types and resources
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1 EntryRelationship
..... @typeCode 1..1 cs Fixed Value: SUBJ
..... @inversionInd 1..1 bl Fixed Value: true
..... observation 1..1 InstructionObservation Base for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Supply.moodCoderequiredMoodCodeEvnInt .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18
Supply.statusCode.coderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933

Constraints

IdGradePath(s)DetailsRequirements
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-highwarningSupply.effectiveTimeSHOULD contain high
: high.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1 II
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: MoodCodeEvnInt . (required)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Binding: VSAC 2.16.840.1.113883.1.11.15933 . (required)
... effectiveTime C 0..1 IVL_TS should-high: SHOULD contain high
... quantity 0..1 PQ
... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
.... participant:product 0..1 Participant2
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: PRD
..... participantRole C 1..1 ProductInstance Base for all types and resources
role-choice: playingDevice and playingEntity are mutually exclusive
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1 EntryRelationship
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 bl Fixed Value: true
..... observation C 1..1 InstructionObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Supply.classCoderequiredFixed Value: SPLY
http://terminology.hl7.org/ValueSet/v3-ActClassSupply
Supply.moodCoderequiredMoodCodeEvnInt .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18
Supply.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Supply.statusCode.coderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
Supply.participant:product.typeCoderequiredFixed Value: PRD
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorSupply.participant:product.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-highwarningSupply.effectiveTimeSHOULD contain high
: high.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:instruction.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C 1..1 Supply XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, priorityCode, repeatNumber, independentInd, quantity, expectedUseTime, product, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcInFulfillmentOf1
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
should-effectiveTime: SHOULD contain effectiveTime
should-quantity: SHOULD contain quantity
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.50
..... @extension 1..1 st Required Pattern: 2014-06-09
... @classCode 1..1 cs Binding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1 cs Binding: MoodCodeEvnInt . (required)
... id 1..* II
... code 0..1 CD Binding: v3 Code System ActCode (example)
... text 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @compression 0..1 cs Binding: CDACompressionAlgorithm (required)
.... @integrityCheck 0..1 bin
.... @integrityCheckAlgorithm 0..1 cs Binding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1 cs
.... @mediaType 0..1 cs Binding: MediaType (example)
.... @representation 0..1 cs Binding: CDABinaryDataEncoding (required)
.... xmlText 0..1 st Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C 0..1 TEL value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1 ED
... statusCode 1..1 CS Binding: ActStatus (required)
.... @code 1..1 cs Binding: VSAC 2.16.840.1.113883.1.11.15933 . (required)
.... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime C 0..1 IVL_TS should-high: SHOULD contain high
... priorityCode 0..* CE Binding: ActPriority (example)
... repeatNumber 0..1 IVL_INT
... independentInd 0..1 BL
... quantity 0..1 PQ
... expectedUseTime 0..1 IVL_TS
... product 0..1 InfrastructureRoot
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... realmCode 0..* CS
.... typeId 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @typeCode 0..1 cs Binding: ParticipationTargetDirect (required)
Fixed Value: PRD
.... manufacturedProduct 1..1 ManufacturedProduct
... subject 0..1 Subject
... specimen 0..* Specimen
... performer 0..* Performer2
... author 0..* Author
... informant 0..* Informant
... Slices for participant 0..* Participant2 Slice: Unordered, Open by value:typeCode
.... participant:product 0..1 Participant2
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: CDAParticipationType (required)
Fixed Value: PRD
..... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1 CE XML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1 IVL_TS
..... awarenessCode 0..1 CE
..... participantRole C 1..1 ProductInstance Base for all types and resources
role-choice: playingDevice and playingEntity are mutually exclusive
... Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1 EntryRelationship
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @typeCode 1..1 cs Binding: x_ActRelationshipEntryRelationship (required)
Fixed Value: SUBJ
..... @inversionInd 1..1 bl Fixed Value: true
..... @contextConductionInd 0..1 bl
..... @negationInd 0..1 bl
..... sequenceNumber 0..1 INT
..... seperatableInd 0..1 BL
..... act 0..1 Act
..... encounter 0..1 Encounter
..... observation C 1..1 InstructionObservation Base for all types and resources
should-text-ref-value: SHOULD contain text/reference/@value
..... observationMedia 0..1 ObservationMedia
..... organizer 0..1 Organizer
..... procedure 0..1 Procedure
..... regionOfInterest 0..1 RegionOfInterest
..... substanceAdministration 0..1 SubstanceAdministration
..... supply 0..1 Supply
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcInFulfillmentOf1 0..* InFulfillmentOf1 XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Supply.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.templateId:non-medicinal-supply-activity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
http://terminology.hl7.org/ValueSet/v3-ActClassSupply
Supply.moodCoderequiredMoodCodeEvnInt .
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.18
Supply.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Supply.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Supply.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Supply.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Supply.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Supply.statusCode.coderequiredhttp://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.15933
Supply.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
http://terminology.hl7.org/ValueSet/v3-ParticipationTargetDirect
Supply.participant:product.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.participant:product.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.participant:product.typeCoderequiredFixed Value: PRD
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Supply.participant:product.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ
http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorSupply.participant:product.participantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-highwarningSupply.effectiveTimeSHOULD contain high
: high.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:instruction.observationSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorSupply.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Supply

Summary

Mandatory: 7 elements(2 nested mandatory elements)
Fixed: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Supply.templateId
  • The element 1 is sliced based on the value of Supply.participant
  • The element 1 is sliced based on the value of Supply.entryRelationship

 

Other representations of profile: CSV, Excel