A_RequestMedicationSupply Tabular View

UKCT_RM140400UK03

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 this is a 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 medication.

The Concept Descriptor (CD) datatype 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.

[0..1] statusCode (CS {CNE:ActStatus} )

The status of the Substance Administration, e.g. active, suspended, completed.

Required if status is "aborted".

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:

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

The date and time the supply is requested for.

[0..1] availabilityTime (TS)

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

[1..1] quantity (PQ)

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 must 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 "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] time (TS)		The time the author authorised the request to supply.

[0..1] modeCode (CS {CNE:ParticipationMode} )		The mode in which the author participated in the request to supply. Required if not "ELECTRONIC" The Coded Only datatype flavour is used to carry this information as follows: The code attribute will contain a value from the list of codes in the ParticipationMode vocabulary.

[1..1] role (AuthorChoice)		The device / agent / person making the request to supply.

[0..1] location

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


[1..1] typeCode (CS {CNE:LOC} ){ Fixed="LOC " }		Indicates that this a location. 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. 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] role (ActLocationChoice)		A link to the choice of location.

[0..1] primaryInformationRecipient

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


[1..1] typeCode (CS {CNE:PRCP} ){ Fixed="PRCP " }		Indicates primary information recipient Fixed value: "PRCP"

[1..1] contextControlCode (CS {CNE:ON} ){ Fixed="ON " }		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. Fixed value: "ON" - Overriding, Non-propagating "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.

[0..1] modeCode (CS {CNE:ParticipationMode} )		The mode in which the primaryInformationRecipient received / will receive the request. For example - "PHONE" , "ELECTRONIC" etc.This must match the modeCode of the author of the request. If the mode is "ELECTRONIC" because the author made the request via a HL7 message instance, then the primaryInformationRecipient in the recommendation CMET shall be the primaryInformationRecipient in the focal act of the same HL7 message. The Coded Only datatype flavour is used to carry this information as follows: The code attribute will contain a value from the list of codes in the ParticipationMode vocabulary.

[1..1] role (PrimaryRecipientChoice)		A link to a choice of primary information recipient

[1..1] product

Refers to the product requested to be supplied.


[1..1] typeCode (CS {CNE:PRD} ){ Fixed="PRD " }		Indicates that the role is that of a product. Fixed value: "PRD"

[0..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. 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] suppliedManufacturedProduct (SuppliedManufacturedProduct)		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] typeCode (CS {CNE:RCV} ){ Fixed="RCV " }		Indicates the participation of receiver. Fixed value: "RCV"

[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. 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] role (RoleChoice)		A link to the choice of receiver.

[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] typeCode (CS {CNE:TRC} ){ Fixed="TRC " }		Indicates the role of copy recipient (tracker). Fixed value: "TRC"

[1..1] contextControlCode (CS {CNE:ON} ){ Fixed="ON " }		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. Fixed value: "ON" - Overriding and Non-propagating "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] role (RoleChoice)		A link to the choice of trackers.

[1..1] pertinentInformation2

Refers to the dosage instructions associated with the request to supply.


[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT " }		Indicates pertinent information. 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'. In this context the seperatableInd is fixed at "false".

[1..1] pertinentDosageInstructions (DosageInstructions)		A link to the dosage instructions.

[0..1] pertinentInformation1

Refers to any additional instructions associated with the request to supply.


[1..1] typeCode (CS {CNE:PERT} ){ Fixed="PERT " }		Indicates pertinent information. 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'. In this context the seperatableInd is fixed at "false".

[1..1] pertinentAdditionalInstructions (AdditionalInstructions)		A link to the additional instructions.

[0..1] inFulfillmentOf

Refers to the plan or request for medication administration that this request to supply would fulfil.


[1..1] typeCode (CS {CNE:FLFS} ){ Fixed="FLFS " }		Indicates 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 default for inversionInd is "false" indicating that the meaning of ActRelationship.typeCode is not reversed.

[1..1] negationInd (BL)		When "true" allows the sender to specifically state that the semantic of the relationship is negated. 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 "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] priorIntendedMedicationAdministrationRef (IntendedMedicationAdministrationRef)		A link to the plan or request for medication administration.

[0..*] sourceOf

A relationship to another clinical statement by reference. The clinical statement may be in the message instance carrying the reference, or on PSIS.

This relationship is to provide kinds of links to clinical statements
not catered for elsewhere in this CMET


[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)		When "true" allows the sender to specifically state that the semantic of the relationship is negated. 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 "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.

AuthorChoice

The agent / device / person authorising the request to supply.

Used by: RequestMedicationSupply

[1..1] either : NonAgentRole

The non agent person.

... or ... : UKCT_MT120701UK02

A CMET identifying the recommending device.

AgentDevice.classCode shall carry a fixed value of "AGNT"

AgentDevice. id shall carry a nationally agreed identifier for the role being played. This shall be a code from a national coding scheme.

A national code is carried in the following way:

The root attribute shall contain the OID that identifies the coding scheme
The extension attribute shall contain the code

If the device can be identified by reference to SDS then

DeviceSDS.classcode shall carry a fixed value of "DEV" to indicates that this is a Device. In this context the device can be hardware or software.

DeviceSDS.determinerCode shall carry a fixed value of "INSTANCE"

DeviceSDS.id shall carry an SDS identifier that uniquely identifies the Device.

This is carried in the following way.

The root attribute shall contain an OID with the appropriate value
The extension attribute shall contain the SDS Device ID

If the device cannot be identified by reference to SDS then

Device.classCode shall carry a fixed value of "DEV"

Device.determinerCode shall carry a fixed value of "INSTANCE"

Device.id shall carry an optional identifier that uniquely identifies the Device. This shall be a code from a national scheme.

A national code is carried in the following way:

The root attribute shall carry the OID that identifies the coding scheme
The extension attribute shall contain the code

If an id is not present, then a name shall be included .

Device.code shall carry an optional code to describe the type of device.

If a code is not present, then a description shall be included.

Device.name shall carry an optional name of the device.

This shall be included if an id is not present.

Device.desc shall carry an optional description of the type of device.

This shall be included if a code is not present.

Device.manufacturerModelName shall optionally carry the model name as allocated by the Device manufacturer.

Device.softwareName shall optionally carry the name of the software used by the Device.

If the device is scoped by an organization then and the organization can be identified by reference to SDS then

OrganizationSDS.classCode shall carry a fixed value of "ORG"

OrganizationSDS.determinerCode shall carry a fixed value of "INSTANCE".

OrganizationSDS.id shall carry an SDS identifier that uniquely identifies the Organization. This is carried in the following way:

The root attribute shall contain an OID with the value 1.2.826.0.1285.0.1.10
The extension attribute shall contain the SDS Organization ID

If the device is scoped by an organization then and the organization cannot be identified by reference to SDS then

Organization.classCode shall carry a fixed value of "ORG"

Organization.determinerCode shall carry a fixed value of "INSTANCE"

Organization.id shall carry an optional identifier that uniquely identifies the Organization. This shall be a code from a national scheme.

A national code is carried in the following way:

the root attribute shall contain the OID that identifies the coding scheme
the extension attribute shall contain the code

If an id is not present, then a name shall be included.

Organization.code shall optionally carry a value from the OrganizationType vocabulary to identify the type of Organization.

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

The code attribute shall contain a value from the list of codes in the OrganizationType vocabulary.

If a code is not present, then a description shall be included.

Organization.name shall optionally contain the name of the Organization. This shall be included if an id is not present.

Organization.desc shall contain a optional description of the type of Organization. This shall be included if a code is not present.

Organization.telecom shall contain optional telephone contact details for the Organization.

Organization.addr shall contain an optional address of the Organization

... or ... : UKCT_MT142101UK01

NPfIT CMET to identify the agent person who is making the recommendation..

The tabular view for this CMET describes it's usage.

ActLocationChoice

The location at which is requested to be performed.

Used by: RequestMedicationSupply

[1..1] either : IncidentalLocation

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

... or ... : UKCT_MT142001UK01

NPfIT CMET to identify the agent organization which is a recipient.

The tabular view for this CMET describes it's usage.

PrimaryRecipientChoice

A choice of primary information recipient.

Used by: RequestMedicationSupply

[1..1] either : UKCT_MT142001UK01

NPfIT CMET to identify the agent organization which is the primary information recipient.

The tabular view for this CMET describes it's usage.

... or ... : UKCT_MT142101UK01

NPfIT CMET to identify the agent person who is the primary information recipient..

The tabular view for this CMET describes it's usage.

SuppliedManufacturedProduct

The virtual or actual product or product pack requested to be supplied

Used by: RequestMedicationSupply

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

Indicates this is a manufactured product.

Fixed value: "MANU"

[1..1] manufacturedManufacturedMaterial (ManufacturedMaterial)

A link to the kind of product requested to be supplied.

RoleChoice

The agent / organization / person performing this participation.

Used by: RequestMedicationSupply, RequestMedicationSupply

[1..1] either : NonAgentRole

The person performing this participation.

... or ... : UKCT_MT142001UK01

NPfIT CMET to identify the agent organization.

The tabular view for this CMET describes it's usage.

... or ... : UKCT_MT142101UK01

NPfIT CMET to identify the agent person.

The tabular view for this CMET describes it's usage.

DosageInstructions

The dosage instructions for this requested medication supply.

Used by: RequestMedicationSupply

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

Indicates that is an observation.

Fixed value: "OBS"

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

Indicates that this is an event.

Fixed value: "EVN"

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

A code taken from the PrescriptionAnnotation vocabulary indicating that this act contains the dosage instructions.

Fixed value: "DI"

[1..1] value (ST)

The dosage instructions in text form.

AdditionalInstructions

Additional instructions for the requested medication supply in human readable form.

Used by: RequestMedicationSupply

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

Indicates that is an observation.

Fixed value: "OBS"

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

Indicates that this is an event.

Fixed value: "EVN"

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

A code taken from the PrescriptionAnnotation vocabulary indicating that this act contains additional instructions.

Fixed value:= "AI"

[1..1] value (ST)

The additional instructions in text form.

IntendedMedicationAdministrationRef

The RequestMedicationAdministration / PlanMedicationAdministration that this supply request is fulfilling.

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:x_ActMoodIntentRequest} )

The moodCode shall contain a value from the HL7 x_ActMoodIntentRequest x domain.

The value shall be only one of the following

"RQO" if a request for medication administration is being referred to.
"INT" if a plan for medication administration is being referred to.

[1..1] id (II)

The unique identifier of the target plan or request to administer.

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 clinical statement.

Used by: RequestMedicationSupply

[1..1] classCode (CS {CNE:ACT} )

"ACT" is the highest level of classCode.

For this ActRef to be utilised properly by the relationships identified within the model, this classCode MUST be changed to the code of the item being referenced.

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

"ActMood" is the highest level of moodCode.

For this ActRef to be utilised properly by the relationships identified within the model, this moodCode MUST be changed to the code of the item being referenced.

[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 not a care professional).

Used by: RequestMedicationSupply, AuthorChoice, RequestMedicationSupply, RoleChoice, RequestMedicationSupply

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

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

A link to the person playing the non-agent role.

IncidentalLocation

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

Used by: RequestMedicationSupply, ActLocationChoice

[1..1] classCode (CS {CNE:ISDLOC} ){ Fixed="ISDLOC " }

Indicates that this is an incidental service delivery location.

Fixed value: "ISDLOC"

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

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

The Coded value (CV) datatype 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)

A relationship to the place playing the role of location.

ManufacturedMaterial

The type of medication being requested to be supplied.

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 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 Plain datatype shall be used to carry this information as follows:

the code attribute will contain the dm+d codification associated with the product or device
the codeSystem attribute will contain the OID for SnomedCT
the displayText attribute will contain the textual (human readable) description associated with the code.

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(s) of the person

Place

An entity describing a place that is not an organization recognised by SDS. If Place is used, at least one of the non-structural attributes MUST 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.

A_RequestMedicationSupply - tabular view