SupplyMedication - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions

Fri Nov 09 12:57:44 GMT 2007

COCD_TP146033UK04
SupplyMedication

A template describing the supply of medication, usually in response to a recorded supply request.

Used by:
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="SPLY" }

Indicates this is a supply.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates this is an event.

[1..1] [M] code (CD {CNE:SupplySnCT } )

A SnomedCT code from the SupplySnCT vocabulary indicating that this is a medication supply act, and an accompanying SnomedCT qualifying code indicating the status of the medication supply act.

The Concept Descriptor (CD) with CDA URL datatype/flavour shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary.
  • The codeSystem attribute shall contain the OID for SnomedCT.
  • The displayName attribute shall carry a description associated with the code in SnomedCT.
  • The originalText element can be used to carry a reference element. This can link the coded item to the relevant text in the CDA section.
  • qualifier (s) may be used if required.
Note the implementation guidance for the domain where this template is used should be consulted regarding correct usage of the originalText element.
[1..1] [M] effectiveTime (TS)

The time which the medication was supplied.


[1..1] [M] id (II)

The unique identifier for this instance of a supply of medication.

The Identifier Global datatype flavour is used to carry the identifier as follows:

  • The root attribute shall contain a DCE UUID
[1..1] [M] statusCode (CS {CNE:ActStatus } ) { Default="completed" }

The status of the supply of medication.

The Coded Only datatype flavour is used to carry this information. The code attribute will contain one of the following values from the list of codes in the Act Status vocabulary:

  • nullified
  • completed
  • active
  • aborted
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#SupplyMedication" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[0..1] author

The person who authored the medication supply.

Only required if different to inherited author or no author is inherited.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="AUT" }

Indicates this is an author.

[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Fixed="OP" }

Specifies how this author contributes to the context of the medication supply and whether it may be propagated to descendent acts whose association allows such propagation.

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true".
[1..1] [M] contentId (II) { "NPFIT-000001#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] functionCode (CV {CNE:AuthorFunctionType } ) { Fixed="OA" }

A code from the vocabulary shown indicating the function of the document author

The Coded Plain flavour of Coded Value (CV) datatype shall be used to carry this information as follows:

  • The code attribute shall contain the value
  • The codeSystem attribute shall contain the OID for the vocabulary concerned
  • The displayName attribute shall contain the text associated with the code
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#author" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] [M] time (TS)

The time at which the author authored the details about the medication supply.

[1..1] participant (AuthorChoice)

A link to the choice of author templates.

[1..1] [M] entryRelationship

Refers to the supply instructions.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }

Indicates this is a component.

[1..1] [M] contextConductionInd (BL) { Fixed="true" }

If true, associations in the parent act are conducted across the Act Relationship to the child act.

[1..1] [M] seperatableInd (BL) { Fixed="false" }

This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#entryRelationship" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] [M] supplyInstructions (SupplyInstructions)

A link to the supply instructions.

[0..*] entryRelationship2

A rereference to any planned or requested administration that stimulated this medication supply.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="REFR" }

Indicates that this is a reference.

[1..1] [M] contextConductionInd (BL) { Fixed="false" }

If true, associations in the parent act are conducted across the ActRelationship to the child act.

[1..1] [M] contentId (II) { "NPFIT-000013#ActRef" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#entryRelationship2" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] referredToPlanOrRequest (PlanOrRequest)

A link to the plan or request for medication templates.

[0..1] entryRelationship4

Refers to the number of days of medication supplied.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }

Indicates this is a component.

[1..1] [M] contextConductionInd (BL) { Fixed="true" }

If true, associations in the parent act are conducted across the Act Relationship to the child act.

[1..1] [M] seperatableInd (BL) { Fixed="false" }

A link to the medication quantity associated with the supply.

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#entryRelationship4" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] daysSupply (DaysSupply)

A link to the medication quantity associated with the supply.

[0..1] entryRelationship5

Refers to the medication quantity supplied.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="COMP" }

Indicates this is a component.

[1..1] [M] contextConductionInd (BL) { Default="true" }

If true, associations in the parent act are conducted across the Act Relationship to the child act.

[1..1] [M] seperatableInd (BL) { Fixed="false" }

This attribute indicates whether or not the source Act is intended to be interpreted independently of the target Act.

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#entryRelationship5" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] medicationQuantity (MedicationQuantity)

A link to the medication quantity associated with the supply.

[0..*] informant

Refers to who informed about the supply of medication.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="INF" }

Indicates this is an informant.

[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Fixed="OP" }

Specifies how the informant contributes to the context of the medication supply and whether they may be propagated to descendent acts whose association allows such propagation.

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true."
[1..1] [M] contentId (II) { "NPFIT-000002#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#informant" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] participant (RoleChoice)

A link to the choice of role templates.

[0..1] location

Refers to the location where the supply took place.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="LOC" }

Indicates that this a location.

[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Default="OP" }

A code that specifies how this location contributes to the context of the medication supply and whether it may be propagated to descendent Acts whose association allows such propagation.

  • Fixed value: "OP" - Overriding and propagating

"O" (Overriding) - the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating) - the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true"

[1..1] [M] contentId (II) { "NPFIT-000004#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#location" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] participant (LocationChoice)

A link to the choice of location templates.

[0..1] performer

The person or device who / which performed the supply.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="PRF" }

Indicates this is a performer.

[1..1] [M] contentId (II) { "NPFIT-000003#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#performer" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] [M] time (IVL<TS>)

The time or duration that the performer was involved in the medication supply.

The date range shall be carried as follows:

If a single point in time is to be carried the Date or Time Point data type shall be used:

  • The center attribute shall contain the date.
This datatype is used if date / duration of the when the performer was involved is not fully known / available

If both a start date and an end date are present the Date or Time Interval Complete data type shall be used:

  • The low attribute shall contain the start date.
  • The high attribute shall contain the end date.


[1..1] participant (PerformerChoice)

A link to the choice of performer templates.

[1..1] [M] product

A relationship to the product supplied. If any product has been supplied, it must be an actual product or product pack.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="PRD" }

Indicates that this is a product.

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#product" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] [M] manufacturedProduct (ManufacturedProduct)

A link to the virtual or actual product or product pack being supplied.

[0..1] receiver

A link to the organization / agent / person receiving the supply of medication.

[1..1] [M] typeCode (CS {CNE:ParticipationType } ) { Fixed="RCV" }

Indicates this is a receiver.

[1..1] [M] contextControlCode (CS {CNE:ContextControl } ) { Fixed="OP" }

Specifies how the receiver contributes to the context of the medication supply and whether they may be propagated to descendent acts whose association allows such propagation.

"O" (Overriding)- the association replaces any context of the same or more specific type that has been conducted from the parent act.

"P" (Propagating)- the association is conducted to all child acts where the ActRelationship.contextConductionInd is set to "true."
[1..1] [M] contentId (II) { "NPFIT-000025#Role" }

This attribute, when valued in an instance, provides a unique forward pointing identifier for a template which constrains the classes and attributes which follow.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.16"
  • The extension attribute shall contain the template artifact Id.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#receiver" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] participant (RoleChoice)

A link to the choice of role templates.

SupplyInstructions

Timing & other information about the administration of the medication that is supplied.

Used by: SupplyMedication
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="OBS" }

Indicates that this is an observation.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that is an event.

[1..1] [M] code (CV {CNE:CDAPrescriptionAnnotation } ) { Fixed="SI" }

A code from the CDAPrescriptionAnnotation vocabulary indicating that this is supply instructions information.

The Coded Value (CV) with CDA URL datatype/flavour shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary
  • The codeSystem attribute shall contain the OID for the vocabulary
  • The displayName attribute shall carry the description associated with the code
  • The originalText element can be used to carry a reference element. This can link the coded item to the relevant text in the CDA section
Note the implementation guidance for the domain where this template is used should be consulted regarding correct usage of the originalText element.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#supplyInstructions" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] [M] value (ST)

Timing and other information about the supplied medication, in textual form.

RoleChoice

An abstract placeholder for the templates of a receiver or informant.

Used by: SupplyMedication
[1..1] either : Template3

A link to the choice of templates for a receiver or informant.

ManufacturedProduct

The role that plays the manufactured product.

Used by: SupplyMedication
[1..1] [M] classCode (CS {CNE:RoleClass } ) { Fixed="MANU" }

Indicates a role scoped by a manufacturer.

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#manufacturedProduct" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
[1..1] [M] manufacturedMaterial (Material)

A link to the manufactured material that is the medication being supplied.

Material

The type of medication being supplied.

Used by: ManufacturedProduct
[1..1] [M] classCode (CS {CNE:EntityClass } ) { Fixed="MMAT" }

Indicates that this is a manufactured material.

[1..1] [M] determinerCode (CS {CNE:EntityDeterminer } )

The determiner code of the material.

The value of determinerCode should be set according to the specification of the drug being carried in the entity.

The CodedOnly datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the EntityDeterminer vocabulary;
[1..1] [M] code (CE {CNE:ManufacturedMaterialSnCT } )

The type of drug being supply in SnomedCT coded form.

The drug can be identified by an actual product description and can be carried either as a textual product representation or as a product pack. The coded form shall include the formulation and strength.

The Coded with Equivalents (CE) with CDA URL datatype/flavour shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary
  • The codeSystem attribute shall contain the OID for SnomedCT
  • The displayName attribute shall carry a description associated with the code in SnomedCT
  • The originalText element can be used to carry a reference element. This can link the coded item to the relevant text in the CDA section

Note the implementation guidance for the domain where this template is used should be consulted regarding correct usage of the originalText element.

[0..1] lotNumberText (ST)

The optional batch number of the material supplied.

Can only be used if determiner code value is "INSTANCE".

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#manufacturedMaterial" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
LocationChoice

A choice of location where the supply took place.

Used by: SupplyMedication
[1..1] either : Template4

A link to a choice of location templates.

PerformerChoice

Refers to the choice of performer of the medication supply.

Used by: SupplyMedication
[1..1] either : Template2

A link to the choice of templates for a performer.

AuthorChoice

Refers to the choice of author of the medication supply.

Used by: SupplyMedication
[1..1] either : Template1

A link to the author templates.

PlanOrRequest

Refers to the plan or request for the medication administration.

Used by: SupplyMedication
[1..1] either : Template

A link to the templates of references of a plan or a request for medication.

MedicationQuantity

Refers to the quantity of medication supplied.

For example "30" tablets supplied

Used by: SupplyMedication
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="SPLY" }

Indicates this is a supply.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }
Indicates this is an event.
[1..1] [M] code (CV {CNE:SnomedCT } ) { Fixed="246205007" }

A fixed code from SnomedCT.

The Coded Value (CV) with CDA URL datatype/flavour shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary
  • The codeSystem attribute shall contain the OID for SnomedCT
  • The displayName attribute shall carry a description associated with the code in SnomedCT
  • The originalText element can be used to carry a reference element. This can link the coded item to the relevant text in the CDA section
Note the implementation guidance for the domain where this template is used should be consulted regarding correct usage of the originalText element.
[1..1] [M] quantity (PQ)

Quantity of drugs supplied for the duration of the medication treatment .

The National Programme mandates the use of the dm+d for expressing drug codes and associated units of measure. The Quantity in Alternative Units datatype flavour is therefore used to carry this information as follows:

  • The value attribute shall contain the integer or decimal (real) number value in the approved unit
  • The unit attribute shall contain the UCUM unit "1"
  • The translation value attribute shall contain the integer or decimal (real) number value in the alternative unit
  • The translation code attribute shall contain the dm+d Unit of Measure codification associated with the drug code
  • The translation codeSystem attribute shall contain the OID for SNOMED CT 2.16.840.1.113883.2.1.3.2.4.15
  • The translation displayName attribute is mandatory and shall contain the text representation of the units as given in the codeSystem (e.g. "gram", "tablet", "unit Course", etc)


For more information on representing drug quantites using dm+d drug codes, see the Implementation of dm+d and Compliance Guide (Ref: NPFIT-ETP-EDB-0068). It should be noted that this guidance does not fully comply with the standard HL7 / UCUM representation of measured quantities in that the PQ unit attribute is assigned a value of "1" (for unity) and not the UCUM representation of the approved unit.

[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#medicationQuantity" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.
DaysSupply

Refers to the number of days medcation supplied.

For example 28 days supply

Used by: SupplyMedication
[1..1] [M] classCode (CS {CNE:ActClass } ) { Fixed="SPLY" }

Indicates this is a supply.

[1..1] [M] moodCode (CS {CNE:ActMood } ) { Fixed="EVN" }

Indicates that is an event.

[1..1] [M] code (CV {CNE:SnomedCT } ) { Fixed="228864003" }

A fixed code from SnomedCT.

The Coded Value (CV) with CDA URL datatype/flavour shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary
  • The codeSystem attribute shall contain the OID for SnomedCT
  • The displayName attribute shall carry a description associated with the code in SnomedCT
  • The originalText element can be used to carry a reference element. This can link the coded item to the relevant text in the CDA section
Note the implementation guidance for the domain where this template is used should be consulted regarding correct usage of the originalText element.
[1..1] [M] expectedUseTime (IVL<TS>)

Date range specifying the number of days treatment that the medication is intended to be provided for.

The Date or Time Duration Unanchored datatype flavour is used to carry this information with as follows:

  • the width.value attribute shall contain the duration in days and shall be assigned a default value of "28"; and
  • the width.unit attribute shall contain the code representing "day", as specified in the Unified Code for Units of Measure (UCUM)
[1..1] [M] id (II)

This is a unique identifier for this instance of a days supply.

The Identifier Global data type flavour is used to carry the identifiers follows:

  • The root attribute shall contain a DCE UUID.
[1..1] [M] templateId (II) { Fixed="COCD_TP146033UK04#daysSupply" }

The fixed value of this attribute provides a unique identifier for the template and the classname within that template.

The IdentifierExternal datatype flavour is used to carry this information as follows:

  • The root attribute shall contain the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The extension attribute shall contain the fixed value.