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

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense Version: 3.0.0-ballot
Draft as of 2023-12-21 Computable Name: MedicationDispense
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.18:2023-05-01

This template records the act of supplying medications (i.e., dispensing). The moodCode equaling “EVN” (Event), signals that the “supply” has occurred and thus has been dispensed.

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-repeatNumber: SHOULD contain repeatNumber
should-quantity: SHOULD contain quantity
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:med-dispense 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1cs
... @moodCode 1..1csFixed Value: EVN
... code 1..1CDThe CDA base standard limits codes that can be used at CDA supply.statusCode. In C-CDA, the Supply.code value set re-uses the value set used in FHIR and FHIR US Core MedicationDispense @ MedicationDispense.status and fixes statsuCode to 'completed'.
Binding: MedicationDispenseStatusCodes (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..1csFixed Value: completed
... effectiveTime 0..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... repeatNumber 0..1IVL_INTIn "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
... quantity 0..1PQ
... product 1..1InfrastructureRoot
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..1Performer2
.... assignedEntity C1..1AssignedEntityshould-addr: SHOULD contain addr
..... addr 0..1USRealmAddressBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, value:typeCode
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.coderequiredMedicationDispenseStatusCodes

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningSupply.performer.assignedEntitySHOULD contain addr
: addr.exists()
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-repeatNumberwarningSupplySHOULD contain repeatNumber
: repeatNumber.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-repeatNumber: SHOULD contain repeatNumber
should-quantity: SHOULD contain quantity
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:med-dispense 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... code 1..1CDThe CDA base standard limits codes that can be used at CDA supply.statusCode. In C-CDA, the Supply.code value set re-uses the value set used in FHIR and FHIR US Core MedicationDispense @ MedicationDispense.status and fixes statsuCode to 'completed'.
Binding: MedicationDispenseStatusCodes (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..1csFixed Value: completed
... effectiveTime 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
... quantity 0..1PQ
... product 1..1InfrastructureRoot
.... manufacturedProduct C1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..1Performer2
.... assignedEntity C1..1AssignedEntityshould-addr: SHOULD contain addr
..... id 1..*II
..... addr C0..1USRealmAddressBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, value:typeCode
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredFixed Value: EVN
Supply.coderequiredMedicationDispenseStatusCodes
Supply.statusCoderequiredActStatus
Supply.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorSupply.performer.assignedEntity.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorSupply.performer.assignedEntity.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
product-choiceerrorSupply.product.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
shall-cityerrorSupply.performer.assignedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorSupply.performer.assignedEntity.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorSupply.performer.assignedEntity.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningSupply.performer.assignedEntitySHOULD contain addr
: addr.exists()
should-countrywarningSupply.performer.assignedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-quantitywarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain quantity
: quantity.exists()
should-repeatNumberwarningSupplySHOULD contain repeatNumber
: repeatNumber.exists()
should-repeatNumberwarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain repeatNumber
: repeatNumber.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningSupply.performer.assignedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.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-repeatNumber: SHOULD contain repeatNumber
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:med-dispense 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.18
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... id 1..*II
... code 1..1CDThe CDA base standard limits codes that can be used at CDA supply.statusCode. In C-CDA, the Supply.code value set re-uses the value set used in FHIR and FHIR US Core MedicationDispense @ MedicationDispense.status and fixes statsuCode to 'completed'.
Binding: MedicationDispenseStatusCodes (required)
... 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..1csFixed Value: completed
.... @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 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INTIn "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 1..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 C1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..1Performer2
.... @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: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... modeCode 0..1CE
.... assignedEntity C1..1AssignedEntityshould-addr: SHOULD contain addr
..... @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
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (example)
..... addr C0..1USRealmAddressBase for all types and resources
..... telecom 0..*TEL
..... assignedPerson 0..1Person
..... representedOrganization 0..1Organization
..... sdtcPatient 0..1BaseXML Namespace: urn:hl7-org:sdtc
XML: patient (urn:hl7-org:sdtc)
...... id 1..1IIXML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, value:typeCode
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @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: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply C1..1MedicationSupplyOrderBase for all types and resources
... 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:med-dispense.nullFlavorrequiredCDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredFixed Value: EVN
Supply.coderequiredMedicationDispenseStatusCodes
Supply.text.nullFlavorrequiredCDANullFlavor
Supply.text.compressionrequiredCDACompressionAlgorithm
Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Supply.text.mediaTypeexampleMediaType
Supply.text.representationrequiredBinaryDataEncoding
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredCDANullFlavor
Supply.priorityCodeexampleActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.performer.nullFlavorrequiredCDANullFlavor
Supply.performer.typeId.nullFlavorrequiredCDANullFlavor
Supply.performer.typeCoderequiredFixed Value: PRF
Supply.performer.assignedEntity.nullFlavorrequiredCDANullFlavor
Supply.performer.assignedEntity.typeId.nullFlavorrequiredCDANullFlavor
Supply.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Supply.performer.assignedEntity.codeexampleRoleCode
Supply.entryRelationship:entryRelationship1.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:entryRelationship1.typeId.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorSupply.performer.assignedEntity.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorSupply.performer.assignedEntity.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
product-choiceerrorSupply.product.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
shall-cityerrorSupply.performer.assignedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorSupply.performer.assignedEntity.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorSupply.performer.assignedEntity.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningSupply.performer.assignedEntitySHOULD contain addr
: addr.exists()
should-countrywarningSupply.performer.assignedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-quantitywarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain quantity
: quantity.exists()
should-repeatNumberwarningSupplySHOULD contain repeatNumber
: repeatNumber.exists()
should-repeatNumberwarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain repeatNumber
: repeatNumber.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningSupply.performer.assignedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.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: 9 elements (1 nested mandatory element)
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.entryRelationship is sliced based on the values of profile:supply, value:typeCode

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-repeatNumber: SHOULD contain repeatNumber
should-quantity: SHOULD contain quantity
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:med-dispense 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1cs
... @moodCode 1..1csFixed Value: EVN
... code 1..1CDThe CDA base standard limits codes that can be used at CDA supply.statusCode. In C-CDA, the Supply.code value set re-uses the value set used in FHIR and FHIR US Core MedicationDispense @ MedicationDispense.status and fixes statsuCode to 'completed'.
Binding: MedicationDispenseStatusCodes (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..1csFixed Value: completed
... effectiveTime 0..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
... repeatNumber 0..1IVL_INTIn "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
... quantity 0..1PQ
... product 1..1InfrastructureRoot
.... manufacturedProduct 1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..1Performer2
.... assignedEntity C1..1AssignedEntityshould-addr: SHOULD contain addr
..... addr 0..1USRealmAddressBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, value:typeCode
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csFixed Value: REFR
..... supply 1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Supply.coderequiredMedicationDispenseStatusCodes

Constraints

IdGradePath(s)DetailsRequirements
should-addrwarningSupply.performer.assignedEntitySHOULD contain addr
: addr.exists()
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-repeatNumberwarningSupplySHOULD contain repeatNumber
: repeatNumber.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-repeatNumber: SHOULD contain repeatNumber
should-quantity: SHOULD contain quantity
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:med-dispense 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.18
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... code 1..1CDThe CDA base standard limits codes that can be used at CDA supply.statusCode. In C-CDA, the Supply.code value set re-uses the value set used in FHIR and FHIR US Core MedicationDispense @ MedicationDispense.status and fixes statsuCode to 'completed'.
Binding: MedicationDispenseStatusCodes (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..1csFixed Value: completed
... effectiveTime 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... repeatNumber 0..1IVL_INTIn "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
... quantity 0..1PQ
... product 1..1InfrastructureRoot
.... manufacturedProduct C1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... performer 0..1Performer2
.... assignedEntity C1..1AssignedEntityshould-addr: SHOULD contain addr
..... id 1..*II
..... addr C0..1USRealmAddressBase for all types and resources
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, value:typeCode
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @typeCode 1..1csBinding: x_ActRelationshipEntryRelationship (required)
Fixed Value: REFR
..... supply C1..1MedicationSupplyOrderBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredFixed Value: EVN
Supply.coderequiredMedicationDispenseStatusCodes
Supply.statusCoderequiredActStatus
Supply.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorSupply.performer.assignedEntity.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorSupply.performer.assignedEntity.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
product-choiceerrorSupply.product.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
shall-cityerrorSupply.performer.assignedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorSupply.performer.assignedEntity.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorSupply.performer.assignedEntity.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningSupply.performer.assignedEntitySHOULD contain addr
: addr.exists()
should-countrywarningSupply.performer.assignedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-quantitywarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain quantity
: quantity.exists()
should-repeatNumberwarningSupplySHOULD contain repeatNumber
: repeatNumber.exists()
should-repeatNumberwarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain repeatNumber
: repeatNumber.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningSupply.performer.assignedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.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-repeatNumber: SHOULD contain repeatNumber
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:med-dispense 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.18
..... @extension 1..1stRequired Pattern: 2023-05-01
... @classCode 1..1csBinding: ActClassSupply (required)
Fixed Value: SPLY
... @moodCode 1..1csBinding: XDocumentSubstanceMood (2.0.0) (required)
Fixed Value: EVN
... id 1..*II
... code 1..1CDThe CDA base standard limits codes that can be used at CDA supply.statusCode. In C-CDA, the Supply.code value set re-uses the value set used in FHIR and FHIR US Core MedicationDispense @ MedicationDispense.status and fixes statsuCode to 'completed'.
Binding: MedicationDispenseStatusCodes (required)
... 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..1csFixed Value: completed
.... @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 0..1
.... effectiveTimeSXCM_TS
.... effectiveTimeIVL_TS
.... effectiveTimeEIVL_TS
.... effectiveTimePIVL_TS
.... effectiveTimeSXPR_TS
... priorityCode 0..*CEBinding: ActPriority (example)
... repeatNumber 0..1IVL_INTIn "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense.
... independentInd 0..1BL
... quantity 0..1PQ
... expectedUseTime 0..1IVL_TS
... product 1..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 C1..1MedicationInformation, ImmunizationMedicationInformationBase for all types and resources
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..1Performer2
.... @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: ParticipationPhysicalPerformer (required)
Fixed Value: PRF
.... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
.... time 0..1IVL_TS
.... modeCode 0..1CE
.... assignedEntity C1..1AssignedEntityshould-addr: SHOULD contain addr
..... @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
..... @classCode 0..1csBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
..... id 1..*II
..... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
..... code 0..1CEBinding: v3 Code System RoleCode (example)
..... addr C0..1USRealmAddressBase for all types and resources
..... telecom 0..*TEL
..... assignedPerson 0..1Person
..... representedOrganization 0..1Organization
..... sdtcPatient 0..1BaseXML Namespace: urn:hl7-org:sdtc
XML: patient (urn:hl7-org:sdtc)
...... id 1..1IIXML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:supply, value:typeCode
.... entryRelationship:entryRelationship1 0..1EntryRelationshipentryRelationship
..... @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: REFR
..... @inversionInd 0..1bl
..... @contextConductionInd 0..1bl
..... @negationInd 0..1bl
..... sequenceNumber 0..1INT
..... seperatableInd 0..1BL
..... act 0..1Act
..... encounter 0..1Encounter
..... observation 0..1Observation
..... observationMedia 0..1ObservationMedia
..... organizer 0..1Organizer
..... procedure 0..1Procedure
..... regionOfInterest 0..1RegionOfInterest
..... substanceAdministration 0..1SubstanceAdministration
..... supply C1..1MedicationSupplyOrderBase for all types and resources
... 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:med-dispense.nullFlavorrequiredCDANullFlavor
Supply.classCoderequiredFixed Value: SPLY
Supply.moodCoderequiredFixed Value: EVN
Supply.coderequiredMedicationDispenseStatusCodes
Supply.text.nullFlavorrequiredCDANullFlavor
Supply.text.compressionrequiredCDACompressionAlgorithm
Supply.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Supply.text.mediaTypeexampleMediaType
Supply.text.representationrequiredBinaryDataEncoding
Supply.statusCoderequiredActStatus
Supply.statusCode.nullFlavorrequiredCDANullFlavor
Supply.priorityCodeexampleActPriority
Supply.product.nullFlavorrequiredCDANullFlavor
Supply.product.typeId.nullFlavorrequiredCDANullFlavor
Supply.product.typeCoderequiredFixed Value: PRD
Supply.performer.nullFlavorrequiredCDANullFlavor
Supply.performer.typeId.nullFlavorrequiredCDANullFlavor
Supply.performer.typeCoderequiredFixed Value: PRF
Supply.performer.assignedEntity.nullFlavorrequiredCDANullFlavor
Supply.performer.assignedEntity.typeId.nullFlavorrequiredCDANullFlavor
Supply.performer.assignedEntity.classCoderequiredFixed Value: ASSIGNED
Supply.performer.assignedEntity.codeexampleRoleCode
Supply.entryRelationship:entryRelationship1.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:entryRelationship1.typeId.nullFlavorrequiredCDANullFlavor
Supply.entryRelationship:entryRelationship1.typeCoderequiredFixed Value: REFR

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorSupply.performer.assignedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorSupply.performer.assignedEntity.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorSupply.performer.assignedEntity.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
product-choiceerrorSupply.product.manufacturedProductmanufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present)
: (manufacturedLabeledDrug | manufacturedMaterial).count() = 1
shall-cityerrorSupply.performer.assignedEntity.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorSupply.performer.assignedEntity.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorSupply.performer.assignedEntity.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningSupply.performer.assignedEntitySHOULD contain addr
: addr.exists()
should-countrywarningSupply.performer.assignedEntity.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-effectiveTimewarningSupplySHOULD contain effectiveTime
: effectiveTime.exists()
should-quantitywarningSupplySHOULD contain quantity
: quantity.exists()
should-quantitywarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain quantity
: quantity.exists()
should-repeatNumberwarningSupplySHOULD contain repeatNumber
: repeatNumber.exists()
should-repeatNumberwarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain repeatNumber
: repeatNumber.exists()
should-text-ref-valuewarningSupplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-text-ref-valuewarningSupply.entryRelationship:entryRelationship1.supplySHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningSupply.performer.assignedEntity.addrSHOULD contain @use
: nullFlavor.exists() or use.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: 9 elements (1 nested mandatory element)
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.entryRelationship is sliced based on the values of profile:supply, value:typeCode

 

Other representations of profile: CSV, Excel