Template

Show index

Template Supply activity 2007‑04‑01

Id2.16.840.1.113883.10.20.1.34Effective Date2007‑04‑01
Statuspending Under pre-publication reviewVersion Label
NameSupplyActivityDisplay NameSupply activity
Description
3.9.2.1.2 Supply activity

ASTM CCR defines a <FulfillmentHistory> element, used to indicate details about a dispensing activity. This corresponds to a supply event (a supply activity in “EVN” mood) in CCD, used to report what was actually filled.

CONF-316: A supply activity (templateId 2.16.840.1.113883.10.20.1.34) SHALL be represented with Supply.
CONF-317: The value for “Supply / @moodCode” in a supply activity SHALL be “EVN” or “INT” 2.16.840.1.113883.5.1001 ActMood STATIC.
CONF-318: A supply activity SHALL contain at least one Supply / id.
CONF-319: A supply activity SHOULD contain exactly one Supply / statusCode.
CONF-320: A supply activity SHOULD contain exactly one Supply / effectiveTime, to indicate the actual or intended time of dispensing.
CONF-321: A supply activity MAY contain exactly one Supply / repeatNumber, to indicate the number of fills. (Note that Supply / repeatNumber corresponds to the number of “fills”, as opposed to the number of “refills”).
CONF-322: A supply activity MAY contain exactly one Supply / quantity, to indicate the actual or intended supply quantity.
CONF-323: A supply activity MAY contain one or more Supply / author, to indicate the prescriber.
CONF-324: A supply activity MAY contain one or more Supply / performer, to indicate the person dispensing the product.
CONF-325: A supply activity MAY contain exactly one Supply / participant / @typeCode = “LOC”, to indicate the supply location.
CONF-326: A supply activity SHALL contain one or more sources of information, as defined in section 5.2 Source.

3.9.2.2.3 Fulfillment instructions

Fulfillment instructions are additional information provided to the dispensing party (e.g. “label in spanish”).

CONF-334: A supply activity MAY contain one or more fulfillment instructions.
CONF-335: A fulfillment instruction (templateId 2.16.840.1.113883.10.20.1.43) SHALL be represented with Act.
CONF-336: The value for “Act / @moodCode” in a fulfillment instruction SHALL be “INT” “Intent” 2.16.840.1.113883.5.1001 ActMood STATIC.
CONF-337: The value for “entryRelationship / @typeCode” in a relationship between a supply activity and fulfillment instruction SHALL be “SUBJ” “Subject” 2.16.840.1.113883.5.1002 ActRelationshipType STATIC.

3.9.2.3 Representation of “status” values

The template identifier for a medication status observation is 2.16.840.1.113883.10.20.1.47.

CONF-350: A medication activity MAY contain exactly one medication status observation.
CONF-351: A supply activity MAY contain exactly one medication status observation.
CONF-352: A medication status observation (templateId 2.16.840.1.113883.10.20.1.47) SHALL be a conformant status observation (templateId 2.16.840.1.113883.10.20.1.57) (as defined in section 5.1 “Type” and “Status” values).
CONF-353: The value for “Observation / value” in a medication status observation SHALL be selected from ValueSet 2.16.840.1.113883.1.11.20.7 MedicationStatusCode STATIC 20061017.

3.9.2.4 Representation of a product

The template identifier for a product is 2.16.840.1.113883.10.20.1.53.
The template identifier for a product instance is 2.16.840.1.113883.10.20.1.52.

CONF-354: A medication activity SHALL contain exactly one SubstanceAdministration / consumable, the target of which is a product template.
CONF-355: A supply activity MAY contain exactly one Supply / product, the target of which is a product template.
CONF-356: A product (templateId 2.16.840.1.113883.10.20.1.53) SHALL be represented with the ManufacturedProduct class.
CONF-357: A ManufacturedProduct in a product template SHALL contain exactly one manufacturedProduct / manufacturedMaterial.
CONF-358: A manufacturedMaterial in a product template SHALL contain exactly one manufacturedMaterial / code.
CONF-359: The value for “manufacturedMaterial / code” in a product template SHOULD be selected from the RxNorm (2.16.840.1.113883.6.88) code system for medications, and from the CDC Vaccine Code (2.16.840.1.113883.6.59) code system for immunizations , or MAY be selected from ValueSet 2.16.840.1.113883.1.11.20.8 MedicationTypeCode STATIC 20061017.
CONF-360: The value for “manufacturedMaterial / code” in a product template MAY contain a precoordinated product strength, product form, or product concentration (e.g. “metoprolol 25mg tablet”, “amoxicillin 400mg/5mL suspension”).
CONF-361: If manufacturedMaterial / code contains a precoordinated unit dose (e.g. “metoprolol 25mg tablet”), then SubstanceAdministration / doseQuantity SHALL be a unitless number that indicates the number of products given per administration.
CONF-362: If manufacturedMaterial / code does not contain a precoordinated unit dose (e.g. “metoprolol product”), then SubstanceAdministration / doseQuantitySHALL be a physical quantity that indicates the amount of product given per administration.
CONF-363: A manufacturedMaterial in a product template SHALL contain exactly one Material / code / originalText, which represents the generic name of the product.
CONF-364: A manufacturedMaterial in a product template MAY contain exactly one Material / name, which represents the brand name of the product.

ASTM CCR defines an optional product size element which can be used to describe the physical characteristics of a product. CDA R2 has no corresponding field, but can uniquely identify a given manufacturer’s product, thereby enabling a complete lookup of any detail related to the product.

CONF-365: A ManufacturedProduct in a product template MAY contain exactly one manufacturedProduct / manufacturerOrganization, which represents the manufacturer of the Material.
CONF-366: A ManufacturedProduct in a product template MAY contain one or more manufacturedProduct / id, which uniquely represent a particular kind of product.
CONF-367: If ManufacturedProduct in a product template contains manufacturedProduct / id, then ManufacturedProduct SHOULD also contain manufacturedProduct / manufacturerOrganization.
CONF-368: A medication activity MAY contain one or more product instance templates (templateId 2.16.840.1.113883.10.20.1.52) (see section 3.14.2.2 Procedure related products), to identify a particular product instance.
CONF-369: A supply activity MAY contain one or more product instance templates (templateId 2.16.840.1.113883.10.20.1.52) (see section 3.14.2.2 Procedure related products), to identify a particular product instance.
CONF-370: Supply / participant / participantRole / idSHOULD be set to equal a [Act | Observation | Procedure] / participant / participantRole / id (see section 3.14.2.2 Procedure related products) to indicate that the Supply and the Procedure are referring to the same product instance.

ContextParent nodes of template element with id 2.16.840.1.113883.10.20.1.34
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 1 transaction and 4 templates, Uses 10 templates
Used by as NameVersion
2.16.840.1.113883.3.1937.777.4.4.1Transactionfinal Continuity of Care Document (CCD) (Release 1.1)2013‑01‑31
2.16.840.1.113883.10.20.1linkpending CCD v1.0 Templates Root2007‑04‑01
2.16.840.1.113883.10.20.1.6Includepending Immunization section2007‑04‑01
2.16.840.1.113883.10.20.1.7Containmentpending Medical equipment section2007‑04‑01
2.16.840.1.113883.10.20.1.8Includepending Medication section2007‑04‑01
Uses as NameVersion
2.16.840.1.113883.3.1937.777.4.10.3Containmentpending CCD Subject (Body)DYNAMIC
2.16.840.1.113883.3.1937.777.4.10.5Containmentpending CCD Author (Body)DYNAMIC
2.16.840.1.113883.3.1937.777.4.10.6Containmentpending CCD DeviceDYNAMIC
2.16.840.1.113883.3.1937.777.4.10.7Containmentpending CCD ManufacturedProductDYNAMIC
2.16.840.1.113883.3.1937.777.4.10.10Containmentpending CCD PlayingEntityDYNAMIC
2.16.840.1.113883.3.1937.777.4.10.15Containmentpending CCD Performer (Body)DYNAMIC
2.16.840.1.113883.10.20.1.40Containmentpending CommentDYNAMIC
2.16.840.1.113883.10.20.1.43Containmentpending Fulfillment instructionsDYNAMIC
2.16.840.1.113883.10.20.1.47Containmentpending Medication status observationDYNAMIC
2.16.840.1.113883.10.20.1.52Containmentpending Product instanceDYNAMIC
RelationshipSpecialization: template 2.16.840.1.113883.10.12.309 (2005‑09‑07)
ItemDTCardConfDescriptionLabel
hl7:supply
CONF‑316
@classCode
cs1 … 1FSPLY
@moodCode
cs1 … 1RCONF‑317
 CONF
@moodCode shall be "EVN"
or
@moodCode shall be "INT"
 Schematron assertrolered error 
 testhl7:participant/hl7:participantRole/hl7:id/concat(@root,'#',@extension)=ancestor::hl7:structuredBody//(hl7:act|hl7:observation|hl7:procedure)/hl7:participant/hl7:participantRole/hl7:id/concat(@root,'#',@extension) 
 MessageCONF-370 / CONF-452: [Act | Observation | Procedure] / participant / participantRole / id SHOULD be set to equal a Supply / participant / participantRole / id (see section 3.9.2.4 Representation of a product) to indicate that the Procedure and the Supply are referring to the same product instance. 
hl7:templateId
II1 … 1CONF‑316
@root
uid1 … 1F2.16.840.1.113883.10.20.1.34
hl7:id
II1 … *CONF‑318
hl7:code
CD0 … 1CONF‑316
 CONF
shall be drawn from concept domain "ActCode"
hl7:text
ED0 … 1CONF‑316
hl7:statusCode
CS1 … 1CONF‑319
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.15933 ActStatus (DYNAMIC)
hl7:effectiveTime
1 … 1CONF‑320
hl7:priorityCode
CE0 … *CONF‑316
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16866 ActPriority (DYNAMIC)
hl7:repeatNumber
IVL_INT0 … 1CONF‑321
hl7:independentInd
BL0 … 1CONF‑316
hl7:quantity
PQ0 … 1CONF‑322
hl7:expectedUseTime
IVL_TS0 … 1CONF‑316
hl7:subject
0 … 1Contains 2.16.840.1.113883.3.1937.777.4.10.3 CCD Subject (Body) (DYNAMIC)CONF‑316
hl7:product
0 … 1RContains 2.16.840.1.113883.3.1937.777.4.10.7 CCD ManufacturedProduct (DYNAMIC)CONF‑355
@typeCode
cs0 … 1FPRD
hl7:performer
0 … *Contains 2.16.840.1.113883.3.1937.777.4.10.15 CCD Performer (Body) (DYNAMIC)CONF‑324
hl7:author
0 … *Contains 2.16.840.1.113883.3.1937.777.4.10.5 CCD Author (Body) (DYNAMIC)CONF‑323
hl7:participant
0 … 1CONF‑325
where [@typeCode='LOC']
@typeCode
cs1 … 1FLOC
@contextControlCode
cs0 … 1FOP
hl7:time
IVL_TS0 … 1CONF‑325
hl7:awarenessCode
CE0 … 1CONF‑325
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10310 TargetAwareness (DYNAMIC)
hl7:participantRole
1 … 1CONF‑325
@classCode
cs0 … 1 
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.11555 RoleClass (DYNAMIC)
hl7:id
II0 … *CONF‑325
hl7:code
CE0 … 1CONF‑325
 CONF
shall be drawn from concept domain "RoleCode"
hl7:addr
AD0 … *CONF‑325
hl7:telecom
TEL0 … *CONF‑325
Choice0 … 1Elements to choose from:
hl7:playingDevice
Contains 2.16.840.1.113883.3.1937.777.4.10.6 CCD Device (DYNAMIC)CONF‑325
hl7:playingEntity
Contains 2.16.840.1.113883.3.1937.777.4.10.10 CCD PlayingEntity (DYNAMIC)CONF‑325
hl7:scopingEntity
0 … 1CONF‑325
@classCode
cs0 … 1 
 CONF
The value of @classCode shall be drawn from value set 2.16.840.1.113883.1.11.10882 EntityClass (DYNAMIC)
@determinerCode
cs0 … 1FINSTANCE
hl7:id
II0 … *CONF‑325
hl7:code
CE0 … 1CONF‑325
 CONF
shall be drawn from concept domain "EntityCode"
hl7:desc
ED0 … 1CONF‑325
hl7:participant
0 … *Contains 2.16.840.1.113883.10.20.1.52 Product instance (DYNAMIC)CONF‑369
@typeCode
cs1 … 1FDEVCONF‑448
@contextControlCode
cs0 … 1FOP
hl7:time
IVL_TS0 … 1CONF‑369
hl7:awarenessCode
CE0 … 1CONF‑369
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.10310 TargetAwareness (DYNAMIC)
hl7:entryRelationship
0 … *Contains 2.16.840.1.113883.10.20.1.43 Fulfillment instructions (DYNAMIC)CONF‑334
where [@typeCode='SUBJ']
@typeCode
cs1 … 1FSUBJCONF‑337
@contextConductionInd
bl0 … 1 
@inversionInd
bl0 … 1 
@negationInd
bl0 … 1 
hl7:sequenceNumber
INT0 … 1CONF‑334
hl7:seperatableInd
BL0 … 1CONF‑334
hl7:entryRelationship
0 … 1Contains 2.16.840.1.113883.10.20.1.47 Medication status observation (DYNAMIC)CONF‑350
@typeCode
cs1 … 1FREFRCONF‑509
@contextConductionInd
bl0 … 1 
@inversionInd
bl0 … 1 
@negationInd
bl0 … 1 
hl7:sequenceNumber
INT0 … 1CONF‑350
hl7:seperatableInd
BL0 … 1CONF‑350
hl7:entryRelationship
0 … *Contains 2.16.840.1.113883.10.20.1.40 Comment (DYNAMIC)CONF‑502
@typeCode
cs1 … 1R
 CONF
The value of @typeCode shall be drawn from value set 2.16.840.1.113883.1.11.19447 x_ActRelationshipEntryRelationship (DYNAMIC)
@contextConductionInd
bl0 … 1 
@inversionInd
bl0 … 1 
@negationInd
bl0 … 1 
hl7:sequenceNumber
INT0 … 1CONF‑502
hl7:seperatableInd
BL0 … 1CONF‑502