Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Non-Medicinal Supply Activity

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/NonMedicinalSupplyActivity Version: 3.0.0-ballot
Draft as of 2023-12-21 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 Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1SupplyXML 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
Instances 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..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 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
... @classCode 1..1cs
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime C0..1IVL_TSshould-high: SHOULD contain high
... quantity 0..1PQ
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... 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
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 C1..1SupplyXML 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
Instances 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..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime C0..1IVL_TSshould-high: SHOULD contain high
... quantity 0..1PQ
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:participant1 0..1Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... participantRole C1..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 C1..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
role-choiceerrorSupply.participant:participant1.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.actSHOULD 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 C1..1SupplyXML 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
Instances 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..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (example)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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..1IVL_TSshould-high: SHOULD contain high
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... 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
.... participant:participant1 0..1Participant2
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole C1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.nullFlavorrequiredCDANullFlavor
Supply.typeId.nullFlavorrequiredCDANullFlavor
Supply.templateId:non-medicinal-supply-activity.nullFlavorrequiredCDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredMoodCodeEvnInt
Supply.codeexampleActCode
Supply.text.nullFlavorrequiredCDANullFlavor
Supply.text.compressionrequiredCDACompressionAlgorithm
Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Supply.text.mediaTypeexampleMediaType
Supply.text.representationrequiredBinaryDataEncoding
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredCDANullFlavor
Supply.statusCode.coderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.nullFlavorrequiredCDANullFlavor
Supply.participant:participant1.typeId.nullFlavorrequiredCDANullFlavor
Supply.participant:participant1.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.contextControlCoderequiredFixed Value: OP
Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorSupply.participant:participant1.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.actSHOULD 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 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 value of value:typeCode
  • The element Supply.entryRelationship is sliced based on the value of profile:act

Differential View

This structure is derived from Supply

NameFlagsCard.TypeDescription & Constraintsdoco
.. Supply C1..1SupplyXML 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
Instances 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..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 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
... @classCode 1..1cs
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CS
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime C0..1IVL_TSshould-high: SHOULD contain high
... quantity 0..1PQ
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... 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
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 C1..1SupplyXML 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
Instances 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..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csBinding: ActStatus (required)
... effectiveTime C0..1IVL_TSshould-high: SHOULD contain high
... quantity 0..1PQ
... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
.... participant:participant1 0..1Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... participantRole C1..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 C1..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
role-choiceerrorSupply.participant:participant1.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.actSHOULD 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 C1..1SupplyXML 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
Instances 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..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:non-medicinal-supply-activity 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (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
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: MoodCodeEvnInt (required)
... id 1..*II
... code 0..1CDBinding: v3 Code System ActCode (example)
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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..1IVL_TSshould-high: SHOULD contain high
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INT
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 0..1InfrastructureRoot
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1st
.... 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
.... participant:participant1 0..1Participant2
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: PRD
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole C1..1ProductInstanceBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act
.... entryRelationship:instruction 0..1EntryRelationship
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... 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 C1..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
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.nullFlavorrequiredCDANullFlavor
Supply.typeId.nullFlavorrequiredCDANullFlavor
Supply.templateId:non-medicinal-supply-activity.nullFlavorrequiredCDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredMoodCodeEvnInt
Supply.codeexampleActCode
Supply.text.nullFlavorrequiredCDANullFlavor
Supply.text.compressionrequiredCDACompressionAlgorithm
Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Supply.text.mediaTypeexampleMediaType
Supply.text.representationrequiredBinaryDataEncoding
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredCDANullFlavor
Supply.statusCode.coderequiredActStatus
Supply.priorityCodeexampleActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.nullFlavorrequiredCDANullFlavor
Supply.participant:participant1.typeId.nullFlavorrequiredCDANullFlavor
Supply.participant:participant1.typeCoderequiredFixed Value: PRD
Supply.participant:participant1.contextControlCoderequiredFixed Value: OP
Supply.entryRelationship:instruction.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:instruction.typeId.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:instruction.typeCoderequiredFixed Value: SUBJ

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorSupply.participant:participant1.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.actSHOULD 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 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 value of value:typeCode
  • The element Supply.entryRelationship is sliced based on the value of profile:act

 

Other representations of profile: CSV, Excel