RequestMedicationSupply - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions

Fri Nov 09 12:57:44 GMT 2007

COCD_TP146032UK04
RequestMedicationSupply

A request for the supply of medication.

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

Indicates that this is a supply.

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

Indicates this is a request.

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

One or more SnomedCT code identifying the act as describing a request for the supply of medication.

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 (IVL<TS>)

The date and time the supply is requested for.

The date range shall be carried as follows:

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

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

If only a start date is present the Date or Time Interval After datatype shall be used:

  • The low attribute shall contain the start date.


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

This is a unique identifier for this instance of a request to 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] quantity (PQ)

The amount of medication requested, including the units (e.g. tablets / packs / millilitres)

[1..1] [M] statusCode (CS {CNE:ActStatus } ) { Default="completed" }

The status of the request to supply.

The Coded Only data type flavour is used to carry this information as follows:

  • The code attribute will contain a one of the following codes from the Act Status vocabulary:
    • nullified
    • active
    • completed
    • aborted.
[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#RequestMedicationSupply" }

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 requset to supply medication.

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

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

Indicates that this is an author.

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

Specifies how this author contributes to the context of the request to supply medication 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_TP146032UK04#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 request to supply medication.

[1..1] participant (AuthorChoice)

A link to the choice of author templates.

[1..1] [M] entryRelationship

Refers to the supply instructions of the requested medication.

[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" }
Indicates if the source Act is to be interpreted independently of the target Act.
[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#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..1] entryRelationship1

A relationship to an act carrying additional details of the request to supply.

[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" }
Indicates if the source Act is to be interpreted independently of the target Act.
[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#entryRelationship1" }

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] additionalInstructions (AdditionalInstructions)

A link to any addintional instructions.

[0..1] entryRelationship2

Refers to a reference to a plan or request for medication administration.

[1..1] [M] typeCode (CS {CNE:ActRelationshipType } ) { Fixed="REFR" }
Indicates 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] seperatableInd (BL) { Fixed="false" }
Indicates if the source Act is to be interpreted independently of the target Act.
[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#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 choice of templates for a plan or request reference.

[0..1] location

Refers to the location at which the medication is requested to be supplied.

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

Indicates this is a location.

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

Specifies how the location contributes to the context of the request to supply medication 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-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_TP146032UK04#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] primaryInformationRecipient

Refers to the agent person or organization that the request to supply is made to.

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

Indicates primary information recipient.

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

A code that specifies how this primary informaation recipient contributes to the context of the request to 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.

"N" (NonPropagating) - the association applies only to this act and any context provided by the association will not be conducted to any child acts.

[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_TP146032UK04#primaryInformationRecipient" }

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 (InformationRecipientChoice)

A link to the choice of information recipient templates.

[1..1] [M] product

Refers to the product requested to be supplied.

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

Indicates that this is a product.

[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#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 manufactured product that is requested to be supplied.

[0..1] receiver

Refers to the organization / agent / person who is requested to receive the supply.

[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 request to supply medication 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_TP146032UK04#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 information recipient templates.

[0..*] tracker

Refers to people or organizations who are identified as copy recipients (trackers) of the request to supply. Trackers of are notified for information only.

There can be zero, one or many copy recipients.

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

Indicates this is a tracker.

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

A code that specifies how this tracker contributes to the context of the request to 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.

"N" (NonPropagating) - the association applies only to this act and any context provided by the association will not be conducted to any child acts

[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_TP146032UK04#tracker" }

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 for a tracker.

InformationRecipientChoice

Refers to the choice of information recipient of the request to supply medication.

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

A link to the information recipient templates.

ManufacturedProduct

The role that plays the manufactured product.

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

Indicates a role scoped by a manufacturer.

[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#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)

link to the manufactured material that is the medication being administered

Material

The role that plays the manufactured product.

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 requested to be supplied 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.

[1..1] [M] templateId (II) { Fixed="COCD_TP146032UK04#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.
AdditionalInstructions

Refers to any additional administration details.

Used by: RequestMedicationSupply
[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 this is an event.

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

A code from the CDAPrescriptionAnnotation vocabulary indicating that these are additional administration details.

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] templateId (II) { Fixed="COCD_TP146032UK04#additionalInstructions" }

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)

The additional administration details in a textual form.

SupplyInstructions

The supply instructions for this requested medication supply.

Used by: RequestMedicationSupply
[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 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] templateId (II) { Fixed="COCD_TP146032UK04#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 supply, in textual form

PlanOrRequest

Refers to the plan or request for the medication administration.

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

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

LocationChoice

Refers to the choice of location where the medication is requested to be supplied.

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

A link to the location templates.

RoleChoice

Refers to the choice of roles for a receiver or tracker.

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

A link to the templates for a recevier or tracker.

AuthorChoice

Refers to the choice of author of the request to supply medication.

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

A link to the author templates.