A_SupplyMedication - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
UKCT_RM140500UK01
SupplyMedication

A CMET describing the supply of medication, usually in response to a recorded supply request.  It covers

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

Indicates that this is an HL7 supply act.

  • Fixed value: = "SPLY"
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN " }

An HL7 MoodCode indicating that the supply act is active or ended.

Fixed value:= "EVN"

[1..2] id (LIST<II>)

The first identifier is mandatory and is the unique national identifier for this instance of a specific clinical statement. The second identifier carries a local identifier allocated by the source system.

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

  • The root attribute shall contain a DCE UUID

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

  • The root carries an OID for the local identifier scheme
  • The extension carries a human-readable identifier from that scheme
[1..1] 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) dataype shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary
  • The code System attribute shall contain the OID for SnomedCT
  • The display text shall carry a description associated with the code in SnomedCT
  • the original text attribute may be used if required
  • qualifier(s) may be used if required.
[1..1] statusCode (CS {CNE:ActStatus} )

The mandatory status of the medication supply act.

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

  • cancelled - the supply will not be provided
  • aborted  - supply has been started, then stopped with no intention to complete it.
  • active - supply is in progress, and is intended to be completed
  • suspended - supply has been suspended after starting it. It may or may not be restarted
  • completed - supply has been completed.
[1..1] effectiveTime (IVL<TS>)

Optional.  The time at which the medication was supplied.

[0..1] activityTime (TS)

Optional - The time at which the medication was supplied.

[0..1] availabilityTime (TS)

Optional. The date and time that the activity was recorded on the original system.

[1..1] quantity (PQ)

The amount of medication supplied.

[1..1] performer

A mandatory participation to the performer / device / person who provided the supply.

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

Indicates the role of primary performer.

  • Fixed value: "PRF"
[1..1] contextControlCode (CS {CNE:OP} ){ Fixed="OP " }

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

  • Default value: "OP" - Overriding and propagating

"The default value of OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting Act Relationships.

[1..1] time (IVL<TS>)

The time atwhich the performer participated in the performance.

[1..1] role (RoleChoice)

The agent / device / person performing this participation.

[0..1] author

An optional participation of the agent / device / person who authored this supply statement.  It SHALL be present if it is not inherited via context conduction.

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

Indicates that the role is the author

  • Fixed value: "AUT"
[1..1] contextControlCode (CS {CNE:OP} ){ Fixed="OP " }

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Fixed value: "OP" - Overriding and propagating

The fixed value of "OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.

[1..1] time (TS)

The time of the author's participation - optional.

[1..1] role (AuthorChoice)

The choice of agent / device acting as author of this supply statement..

[0..1] location

An optional participation to the location at which the supply act took place.

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

Indicates that this a location participation.

Fixed value:= "LOC"

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

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Fixed value: "OP" - Overriding and propagating

The fixed value of "OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.

[1..1] role (ActLocation)

The choice containing the location.

[0..*] participant

An optional participation to any other participant not explicitly catered for elsewhere in this CMET.

[1..1] typeCode (CS {CNE:ParticipationType} )

Indicates the nature of the participation. It shall contain a value taken from the HL7 ParticipationType vocabulary.

[1..1] contextControlCode (CS {CNE:ContextControl} )

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Fixed value: "OP" - Overriding and propagating

The fixed value of "OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.

[1..1] time (IVL<TS>)

The time at which the participant was involved in the activity.

[1..1] agent      [CMET: UKCT_MT120101UK04]

The agent acting as the participant. It shall be a person   / organisation / device, and be known or not known to NPfIT SDS.

[1..1] product

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

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

Indicates that this is a product participation.

  • Fixed value:= "PRD"
[1..1] contextControlCode (CS {CNE:OP} ){ Fixed="OP " }

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Fixed value: "OP" - Overriding and propagating

The fixed value of "OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.

[1..1] suppliedManufacturedProduct (SuppliedManufacturedProduct)

The virtual or actual product or product pack  being requested.

[1..1] receiver

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

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

Indicates that this is a receiver participation.

[1..1] contextControlCode (CS {CNE:ContextControl} )

A code that specifies how this Participation contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation.

The value of contextControlCode should be set appropriately according to the context of the participation being modelled.

  • Fixed value: "OP" - Overriding and propagating

The fixed value of "OP" indicates that the association overrides the existing context associated with the Act, and will propagate to any descendant Acts reached by conducting ActRelationships.

[1..1] role (ReceiverChoice)
[0..1] pertinentInformation

An optional link to any additional instructions issued to the receiver at the time of supply, e.g. how to store or handle the supplied product

[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT " }

Indicates that this is a pertinent information relationship.

  • Fixed value:= "PERT"
[1..1] contextConductionInd (BL)

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

In this context the contextConductionInd is fixed at  "true".

[1..1] seperatableInd (BL)

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

If the source act is intended to be interpreted independently the value shall be 'true' otherwise the value shall be 'false'.

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd is fixed as  "false".

[1..1] pertinentSupplyInstructions (SupplyInstructions)

The related supply instructions

[0..1] inFulfillmentOf1

Optional relationship to the planned medication administration that this supply is intended for.

[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS " }

Indicates that this is a "fulfilment" relationship.

Fixed value:="FLFS"

[1..1] inversionInd (BL)

An indicator specifying that the ActRelationship.typeCode should be interpreted as if the roles of the source and target Acts were reversed. The inversion indicator is used when the meaning of ActRelationship.typeCode must be reversed.

The inversionInd is fixed at "false" indicating that the meaning of ActRelationship.typeCode is not reversed.

[1..1] negationInd (BL)

If true, indicates that the specified participation did not, is not or should not occur (depending on mood).

In this case the negationInd is fixed at "false"

[1..1] seperatableInd (BL)

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

If the source act is intended to be interpreted independently the value shall be 'true' otherwise the value shall be 'false'.

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd is fixed at "true".

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Direct Relationship" mechanism.

The Identifier External 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 shall contain the fixed template ID
    "CSAB_RM-NPfITUK10.sourceOf1"
[1..1] priorPlanMedicationAdministrationRef (PlanMedicationAdministrationRef)

The planned medication administration that this supply is intended for.

[0..1] inFulfillmentOf2

An optional link to the supply request this supply act is satisfying.

[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS " }

Indicates that this is a "fulfilment" relationship.

Fixed value:="FLFS"

[1..1] inversionInd (BL)

An indicator specifying that the ActRelationship.typeCode should be interpreted as if the roles of the source and target Acts were reversed. The inversion indicator is used when the meaning of ActRelationship.typeCode must be reversed.

The inversionInd is fixed at "false" indicating that the meaning of ActRelationship.typeCode is not reversed.

[1..1] negationInd (BL)

If true, indicates that the specified participation did not, is not or should not occur (depending on mood).

In this case the negationInd is fixed at "false"

[1..1] seperatableInd (BL)

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

If the source act is intended to be interpreted independently the value shall be 'true' otherwise the value shall be 'false'.

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd is fixed at "true".

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Direct Relationship" mechanism.

The Identifier External 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 shall contain the fixed template ID
    "CSAB_RM-NPfITUK10.sourceOf1"
[1..1] priorRequestMedicationSupplyRef (RequestMedicationSupplyRef)

The supply request this supply act is satisfying.

[0..*] sourceOf

An optional link to a reference to another clinical statement.  The clinical statement may be in the message instance carrying the reference, or on PSIS.

[1..1] typeCode (CS {CNE:ActRelationshipType} )

A code specifying the nature of the link.

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 ActRelationshipType vocabulary
[1..1] inversionInd (BL)

An indicator specifying that the ActRelationship.typeCode should be interpreted as if the roles of the source and target Acts were reversed. The inversion indicator is used when the meaning of ActRelationship.typeCode must be reversed.

The default for inversionInd is "false" indicating that the meaning of ActRelationship.typeCode is not reversed.

[0..1] sequenceNumber (INT)

An integer specifying the relative ordering of this relationship among other like-types relationships having the same source Act.

[1..1] negationInd (BL)

If true, indicates that the specified participation did not, is not or should not occur (depending on mood).

In this context the negationInd defaults to "false".

[1..1] seperatableInd (BL)

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

If the source act is intended to be interpreted independently the value shall be 'true' otherwise the value shall be 'false'.

The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd is defaults to "true".

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Reference" mechanism.

The Identifier External 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 shall contain the template ID "CSAB_RM-NPfITUK10.sourceOf1".
[1..1] target (ActRef)

The clinical statement being referred to.

RoleChoice

The agent / device / person performing this participation.

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

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120601UK02

A CMET describing a device participant known to NPfIT SDS.

             ... or ... : UKCT_MT120201UK03

A CMET describing a healthcare professional participant known to NPfIT SDS

AuthorChoice

The agent / device / person performing this participation.

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

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120201UK03

The agent / device / person performing this participation.

ActLocation

The location at which this administration was performed..

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

A location which is not related to an organisation known to NPfIT SDS

             ... or ... : UKCT_MT120501UK03

A CMET describing a location at or in part of an organisation known to NPfIT SDS.

SuppliedManufacturedProduct

The virtual or actual product or product pack supplied.

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

Indicates that this is a role played by a manufactured product.

Fixed value: = "MANU"

[1..1] manufacturedManufacturedMaterial (ManufacturedMaterial)
ReceiverChoice

The agent / device / person performing this participation.

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

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120501UK03

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120301UK02

The agent / device / person performing this participation.

SupplyInstructions

The instructions issued to the receiver with this medication supply

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

Indicates that is class describes an observation.

  • Fixed value:= "OBS"
[1..1] moodCode (CS {CNE:EVN} ){ Fixed="EVN " }

Mood code indicating that this observation has been made.

  • Fixed value:="EVN"
[1..1] code (CV {CNE:PrescriptionAnnotation} )

A code from the PrescriptionAnnotation vocabulary identifying that this class holds additional supply instructions.

The Coded Value (CV) dataype shall be used to carry this information as follows:

  • The code attribute shall contain a fixed value- "SI".
  • The code System attribute shall contain the OID for the PrescriptionAnnotation vocabulary
[1..1] value (ST)

The supply instructions in text form.

PlanMedicationAdministrationRef

The planned medication administration that this supply is intended for.

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

Indicates that the clinical statement referred to is an HL7 substance administration act.

  • Fixed value:= "SBADM"
[1..1] moodCode (CS {CNE:INT} ){ Fixed="INT " }

The mood code of the clinical statement referred to.

Fixed value:= "INT"

[1..1] id (II)

A unique identifier for this instance of a planned medication administration statement.

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

  • The root attribute shall contain a DCE UUID.
RequestMedicationSupplyRef

The medication supply request that this supply act is intended to satisfy.

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

Indicates that this is an HL7 supply act.

  • Fixed value: = "SPLY"
[1..1] moodCode (CS {CNE:RQO} ){ Fixed="RQO " }

Indicates that the act is a request.

  • Fixed value:= "RQO"
[1..1] id (II)

A unique identifier for this instance of a medication supply request statement.

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

  • The root attribute shall contain a DCE UUID.
ActRef

A reference to any other clnical statement.

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

The class of the Act being referenced.  It shall contain a value from the HL7 ActClass vocabulary.

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

The mood code of the Act being referenced. It shall contain a value from the HL7 ActMood vocabulary.

[1..1] id (II)

The unique national identifier for this instance of the clinical statement being referred to. 

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

  • The root attribute shall contain a DCE UUID
NonAgentRole

A role played by a person who is not an agent  (i.e. a care professional).

Used by: SupplyMedication, RoleChoice
[1..1] classCode (CS {CNE:ROL} ){ Fixed="ROL " }

Indicates this is a role.

  • Fixed value: "ROL"
[0..1] id (II)

An optional unique identifier of the role-player.  May be used to convey the NHS number of a patient who is playing a role.  It shall be comprise an OID for the identification scheme and the identifier within that scheme (e.g. for patient NHS number.

[0..1] code (CV {CNE:PersonRelationshipType} )

A code identifying the relationship of the non-agent person to the patient, e.g. parent  or carer.

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

  • The code attribute shall contain a value from the list of codes in the vocabulary
  • The code System attribute shall contain the OID for the vocabulary
  • The display text attribute will carry a description for the code from the vocabulary.
[0..1] playingNonAgentPerson (NonAgentPerson)

An optional link to the person palying the non-agent role.

IncidentalLocation

A location which is not related to an organisation known to NPfIT SDS

Used by: SupplyMedication, ActLocation
[1..1] classCode (CS {CNE:ISDLOC} ){ Fixed="ISDLOC " }

Indicates that this is an incidental service deklivery location.

Fixed value:= "ISDLOC"

[1..1] code (CV {CNE:LocationTypeSnCT} )

This indicates the type of the location, represented using a SnomedCT code.

The Coded Plain flavour of the CV dataype shall be used to carry this information as follows:

  • The code attribute shall contain a code from the relevant vocabulary
  • The code System attribute shall contain the OID for SnomedCT
  • The display text shall carry a description associated with the code in SnomedCT
[0..1] location (Place)
ManufacturedMaterial
The type of medication being administered
Used by: SuppliedManufacturedProduct
[1..1] classCode (CS {CNE:MMAT} ){ Fixed="MMAT " }

Indicates that this is a manufactured material.

  • Fixed value: "MMAT"
[1..1] determinerCode (CS {CNE:EntityDeterminer} )

The determiner code of the entity.

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] code (CE {CNE:ManufacturedMaterialSnCT} )

The type of drug being administered in SnomedCT coded form.

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

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

  • The code attribute shall contain a value from the list of codes in the vocabulary
  • The code System attribute shall contain the OID for SnomedCT
  • the displayText shall contain a description for the code from the coding system
  • the original text attribute may be used if required
  • the translation attribute shall not be used.

NOTE: this attribute was intended to use the CD dataype, but HL7 tooling issues make this impossible. 

[0..1] lotNumberText (ST)

The optional batch number of the material administered.

NonAgentRole1

A role played by a person who is not an agent  (i.e. a care professional).

Used by: SupplyMedication, ReceiverChoice
[1..1] classCode (CS {CNE:ROL} ){ Fixed="ROL " }

Indicates this is a role.

  • Fixed value: "ROL"
[0..1] id (II)

An optional unique identifier of the role-player.  May be used to convey the NHS number of a patient who is playing a role.  It shall be an OID for the identification scheme and the identifier within that scheme (e.g. for patient NHS number).

[0..1] code (CV {CNE:PersonRelationshipType} )

A code identifying the relationship of the non-agent person to the patient, e.g. parent  or carer.

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

  • The code attribute shall contain a value from the list of codes in the  vocabulary
  • The code System attribute shall contain the OID for the vocabulary
  • The display text attribute will carry a description for the code from the vocabulary.
[0..1] playingNonAgentPerson1 (NonAgentPerson1)

An optional link to the person palying the non-agent role.

NonAgentPerson

Someone who is not known to the NPfIT SDS.

Used by: NonAgentRole
[1..1] classCode (CS {CNE:PSN} ){ Fixed="PSN " }

Indicates that the entity is a person

  • Fixed value: "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable person.

  • Fixed value: "INSTANCE"
[1..*] name (SET<PN>)

The name of the person

Place

An entity describing a place that is not an organisation recognised by SDS.  If Place is used, at least one of the non-structural attributes SHALL be used. 

Used by: IncidentalLocation
[1..1] classCode (CS {CNE:PLC} ){ Fixed="PLC " }

Indicates that the entity is a place

  • Fixed value: "PLC"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable place

  • Fixed value: "INSTANCE"
[0..1] name (TN)

The optional name of the place

[0..1] telecom (TEL)

An optional telecom contact for the place

[0..1] addr (AD)

An optional address of the place

[0..1] positionText (ED)

An optional grid reference. It may be as precise as required.

[0..1] gpsText (ST)

An optional GPS reference.  It may be as precise as required.

NonAgentPerson1
Details of the non-agent person.
Used by: NonAgentRole1
[1..1] classCode (CS {CNE:PSN} ){ Fixed="PSN " }

Indicates that the entity is a person

  • Fixed value: "PSN"
[1..1] determinerCode (CS {CNE:INSTANCE} ){ Fixed="INSTANCE " }

Indicates that the entity is a single identifiable person.

  • Fixed value: "INSTANCE"
[1..1] name (PN)

The name of the person.