A_RequestMedicationSupply - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
UKCT_RM140400UK01
RequestMedicationSupply

A request for the supply  It may be  of a medicinal product, e.g. as carried on an FP10 prescription form.

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

Indicates that this is a supply act.

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

Indicates that the mood of an act is" request".

  • Fixed value:= "RQO"
[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:SupplyRequestSnCT} )

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

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 Substance Administration, e.g. active, suspended, completed. 

 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 Act Status vocabulary: 

  • aborted - the  request has been aborted
  • active - the request is active but hasn't been accepted yet by a supplier
  • completed - the request has been accepted by a supplier.
[0..1] effectiveTime (GTS)

Optional - not for use in P1R2.  The time when the supply is to be supplied..

[1..1] activityTime (TS)

Optional - the time at which the request was made.

[0..1] availabilityTime (TS)

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

[1..1] quantity (PQ)

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

[0..1] author

The participation of the agent / device / person who authored this request medication 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] agent      [CMET: UKCT_MT120201UK03]

A CMET describing the author of the request medication supply statement. 

[0..1] location

An optional participation of the location at which this request medication supply statement was generated.

[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.

[1..1] product

A mandatory participation to the virtual or actual product or product pack being requested.

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

Indicates that this is a product

[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] suppliedManufacturedProduct (SuppliedManufacturedProduct)

The virtual or actual product or product pack  being requested.

[0..1] receiver

An optional participation to the organisation / agent / person who is to receive 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)

A choice of the the organisation / agent / person who is to receive the supply of medication.

[0..1] pertinentInformation

This relationship will be removed as soon as possible.

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

Indicates that this is a pertinent information relationship.

  • Fixed value:= "PERT"
[1..1] inversionInd (BL)
[1..1] negationInd (BL)
[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] templateId (II)
[1..1] pertinentRequestMedicationAdministration      [CMET: UKCT_MT140801UK01]
[0..1] sequelTo

An optional link to the planned / requested medication administration for which this is the supply request.

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

Indicates that this is a "sequel" relationship.

  • Fixed value := "SEQL"
[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.

[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 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 defaults to "false".

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "ReferenceRelationship" 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] priorMedicationAdministrationRef (MedicationAdministrationRef)

The planned / requested medication administration for which this is the supply request.

[0..*] sourceOf1

An optional link to zero or more references to to external clinical statements via kinds of relationship not explicitly modelled in this CMET.

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

The nature of the relationship.  It shall be expressed in a value chosen from the HL7 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 optional 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 case 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 fixed at "true".

[1..1] templateId (II)

An identifier of the Act Relationship that categorises clinical data by it's role within the message instance.

 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 external clinical statement being referred to.

ActLocation

The location at which this administration was performed..

Used by: RequestMedicationSupply
[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 to be supplied.

Used by: RequestMedicationSupply
[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)

The kind of product to be supplied.

ReceiverChoice

The agent / device / person performing this participation.

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

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120501UK03

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120201UK03

The agent / device / person performing this participation.

MedicationAdministrationRef

The RequestMedicationAdministration / PlanMedicationAdministration that this is the supply request for.

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

Indicates that this is a substance administration act.

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

The mood code of the referenced act.  It will be "INT" if it is a Plan MedicationAdministration or "RQO" if it is a RequestMedicationAdministration.

[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
ActRef

A reference to any other clnical statement.

Used by: RequestMedicationSupply
[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
IncidentalLocation

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

Used by: RequestMedicationSupply, 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. 

NonAgentRole

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

Used by: RequestMedicationSupply, 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 comprise an OID for the identification scheme and the identifier within that scheme (e.g. for patient NHS number.

[1..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.

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.

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