Left: | Medication Dispense (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense) |
Right: | Medication Dispense (http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense) |
Error | StructureDefinition.version | Values for version differ: '3.0.0' vs '4.0.0-ballot' |
Information | StructureDefinition.date | Values for date differ: '2024-05-18T00:16:25-05:00' vs '2024-11-21T20:34:36+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/cda/stds/core/StructureDefinition/Supply | ||
copyright | |||
date | 2024-05-18T00:16:25-05:00 | 2024-11-21T20:34:36+00:00 |
|
description | 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. | ||
experimental | |||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | logical | ||
name | MedicationDispense | ||
publisher | Health Level Seven | ||
purpose | |||
status | draft | ||
title | Medication Dispense | ||
type | http://hl7.org/cda/stds/core/StructureDefinition/Supply | ||
url | http://hl7.org/cda/us/ccda/StructureDefinition/MedicationDispense | ||
version | 3.0.0 | 4.0.0-ballot |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments |
---|---|---|---|---|---|---|---|---|---|
Supply | C | 1..1 | Supply | 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-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity | C | 1..1 | Supply | 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-repeatNumber: SHOULD contain repeatNumber should-quantity: SHOULD contain quantity | |
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |||
classCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: SPLY | 1..1 | ?? | Binding: ?? (required) Fixed Value: SPLY | |||
moodCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: EVN | 1..1 | ?? | Binding: ?? (required) Fixed Value: EVN | |||
id | 1..* | II | 1..* | II | |||||
code | 1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: ?? (required) | 1..1 | CD | The CDA base standard limits codes that can be used at CDA supply.statusCode which do not represent typical medication dispense statuses. In order to provide correct domain vocabulary and align with FHIR, CDA supply.statusCode is fixed to completed and the FHIR MedicationDispense status value set is used at supply.code. Binding: ?? (required) | |||
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
compression | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
integrityCheck | 0..1 | ?? | 0..1 | ?? | |||||
integrityCheckAlgorithm | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
language | 0..1 | ?? | 0..1 | ?? | |||||
mediaType | 0..1 | ?? | Binding: ?? (example) | 0..1 | ?? | Binding: ?? (example) | |||
representation | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
xmlText | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | 0..1 | ?? | 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 | 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 | 0..1 | ED | |||||
statusCode | 1..1 | CS | Binding: ?? (required) | 1..1 | CS | Binding: ?? (required) | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
code | 1..1 | ?? | Fixed Value: completed | 1..1 | ?? | Fixed Value: completed | |||
codeSystem | 0..0 | 0..0 | |||||||
codeSystemName | 0..0 | 0..0 | |||||||
codeSystemVersion | 0..0 | 0..0 | |||||||
displayName | 0..0 | 0..0 | |||||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..0 | 0..0 | |||||||
qualifier | 0..0 | 0..0 | |||||||
translation | 0..0 | 0..0 | |||||||
effectiveTime | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | 0..1 | SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS | |||||
priorityCode | 0..* | CE | Binding: ?? (example) | 0..* | CE | Binding: ?? (example) | |||
repeatNumber | 0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | 0..1 | IVL_INT | In "EVN" (event) mood, the repeatNumber is the number of dispenses. For example, a repeatNumber of "3" indicates the third dispense. | |||
independentInd | 0..1 | BL | 0..1 | BL | |||||
quantity | 0..1 | PQ | 0..1 | PQ | |||||
expectedUseTime | 0..1 | IVL_TS | 0..1 | IVL_TS | |||||
product | 1..1 | InfrastructureRoot | 1..1 | InfrastructureRoot | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
templateId | 0..* | II | 0..* | II | |||||
typeCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: PRD | 0..1 | ?? | Binding: ?? (required) Fixed Value: PRD | |||
manufacturedProduct | C | 1..1 | ??, ?? | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) | C | 1..1 | ??, ?? | Base for all types and resources product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) | |
subject | 0..1 | Subject | 0..1 | Subject | |||||
specimen | 0..* | Specimen | 0..* | Specimen | |||||
performer | 0..1 | Performer2 | 0..1 | Performer2 | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
templateId | 0..* | II | 0..* | II | |||||
typeCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: PRF | 0..1 | ?? | Binding: ?? (required) Fixed Value: PRF | |||
sdtcFunctionCode | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | 0..1 | CE | XML: functionCode (urn:hl7-org:sdtc) | |||
time | 0..1 | IVL_TS | 0..1 | IVL_TS | |||||
modeCode | 0..1 | CE | 0..1 | CE | |||||
assignedEntity | C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr | C | 1..1 | AssignedEntity | should-addr: SHOULD contain addr | |
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
templateId | 0..* | II | 0..* | II | |||||
classCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: ASSIGNED | 0..1 | ?? | Binding: ?? (required) Fixed Value: ASSIGNED | |||
id | 1..* | II | 1..* | II | |||||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |||
code | 0..1 | CE | Binding: ?? (example) | 0..1 | CE | Binding: ?? (example) | |||
addr | C | 0..1 | ?? | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If 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). 81-10025: If 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country | C | 0..1 | ?? | Base for all types and resources shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If 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). 81-10025: If 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country | |
telecom | 0..* | TEL | 0..* | TEL | |||||
assignedPerson | 0..1 | Person | 0..1 | Person | |||||
representedOrganization | 0..1 | Organization | 0..1 | Organization | |||||
sdtcPatient | 0..1 | Base | XML: patient (urn:hl7-org:sdtc) | 0..1 | Base | XML: patient (urn:hl7-org:sdtc) | |||
id | 1..1 | II | XML Namespace: urn:hl7-org:sdtc | 1..1 | II | XML Namespace: urn:hl7-org:sdtc | |||
author | 0..* | Author | 0..* | Author | |||||
informant | 0..* | Informant | 0..* | Informant | |||||
participant | 0..* | Participant2 | 0..* | Participant2 | |||||
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | 0..* | EntryRelationship | Slice: Unordered, Open by profile:supply, value:typeCode | |||
reference | 0..* | Reference | 0..* | Reference | |||||
precondition | 0..* | Precondition | 0..* | Precondition | |||||
sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |||
Documentation for this format |