A_RequestMedicationSupplyAbort - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
UKCT_RM140600UK01
RequestMedicationSupplyAbort

A CMET representing a request to abort a request to supply medication.

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

One or more SnomedCT code identifying the act as describing a request to abort a medication supply request. 

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 request to abort the medication supply request. 

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

  • active - recommendation is in force
  • cancelled - the request has been withdrawn
  • completed - the request has been complied with.
[0..1] effectiveTime (GTS)

Optional - not for use in P1R2.  The time when the request to abort was made..

[1..1] activityTime (TS)

Optional - the time at which the request to abort was made.

[0..1] availabilityTime (TS)

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

[0..1] author

An optional participation of the agent / device / person who authored this request to abort supply request 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. 

[1..1] primaryInformationRecipient

A mandatory participation representing the agent / organisation to whom the request is directed

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

Indicates that this is a primary information recipient relationship.

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

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

  • Fixed value: "ON" - Overriding and not propagating

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

[1..1] role (PrimaryRecipient)

The agent / organisation to whom the request is directed

[0..1] primaryPerformer

An optional participation of the person who made the request.  Usually the same as the author.

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

Indicates that this is a primary performer participation.

  • Fixed value:= "PPRF"
[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 (IVL<TS>)

The time at which the performer made the request.

[1..1] agent (UKCT_MT120301UK02)

A CMET describing a person agent known to NPfIT SDS.

[0..*] tracker

An optional participation of a person / organisation to whom the request is to be copied.nnn

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

Indicates that this is a tracker participation.

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

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

  • Fixed value: "ON" - Overriding and not propagating

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

[1..1] role (CopyRecipient)

A person / organisation known to NPfIT SDS acting as a copy recipient..

[0..1] pertinentInformation

An optional link to textual information describing the reason for aborting the supply request.

[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 defaults to "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] pertinentReasonSupportingInfo (ReasonSupportingInfo)

Textual information describing the reason for aborting the supply request.

[1..*] reason

A link to one oe more structured information that justifies the abortion of this medication supply request. The structured information may be fully represented in this CMET, or an external reference.

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

Indicates that this is a reason relationship type.

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

[0..1] contextConductionInd (BL)

This field SHALL present if this is a relationship to an act, and SHALL NOT be present if it is to a reference to an Act.  In the first case the template idenifier will be "CSAB_RM-NPfITUK10.sourceOf2", and in the second case "CSAB_RM-NPfITUK10.sourceOf1".

If present, it has a fixed value of "true", i.e.associations in the parent act are conducted across the Act Relationship to the child act.

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

[1..1] templateId (II)

An identifier of the Act Relationship that supports the linkage of clinical statements using the "Direct Relationship" or "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 fixed template ID "CSAB_RM-NPfITUK10.sourceOf1" if the relationship points to an Act reference, and "CSAB_RM-NPfITUK10.sourceOf2" if the relationship points to an Act.
[1..1] target (ReasonChoice)

The choice of act / act ref that is acting as the reason .

[1..1] sequelTo

A link to the (existing) medication supply request to be aborted. 

[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 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 "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] priorRequestMedicationSupplyRef (RequestMedicationSupplyRef)

The medication supply request to be aborted.

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

PrimaryRecipient

The organisation / person asked to action this request.

Used by: RequestMedicationSupplyAbort
[1..1] either : UKCT_MT120501UK03

A CMET describing an organisation known to NPfIT SDS.

             ... or ... : UKCT_MT120301UK02

A CMET describing a person agent known to NPfIT SDS

CopyRecipient

The organisation / person receiving a copy of this request.

Used by: RequestMedicationSupplyAbort
[1..1] either : UKCT_MT120401UK03

A CMET describing an organisation known or not known to NPfIT SDS.

             ... or ... : UKCT_MT120201UK03

A CMET describing a person known or not known to NPfIT SDS.

ReasonSupportingInfo

A textual representation of the reason for this request to abort a medication supply request.

Used by: RequestMedicationSupplyAbort
[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:ReasonFor} )

A value from the ReasonFor vocabulary indicating that this provides information about the reason why this medication supply request should be aborted.

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

  • The code attribute shall contain a fixed value of "RAMSR"
  • The code System attribute shall contain the OID for the vocabulary concerned. 
[1..1] value (ST)

A string containing the reason.

ReasonChoice

A choice of a reason / reference to a reason why this dose administration was not completed.

Used by: RequestMedicationSupplyAbort
[1..1] either : Observation

An observation acting as a reason

             ... or ... : ReasonForAbortRef

A reference to an act acting as a reason

RequestMedicationSupplyRef

The medication supply request that this CMET requestes to abort.

Used by: RequestMedicationSupplyAbort
[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: RequestMedicationSupplyAbort
[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
Observation

An observation acting as a reson for requesting the abortion of a medication supply request.

Used by: RequestMedicationSupplyAbortReasonChoice
[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..2] id (LIST<II>)

 set of unique identifiers for this instance of an observation.

The first is mandatory and is a unique identifier for this instance of a specific clinical statement. The second is optional and allows an observation to be identified by a local identifier.

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

One or more SnomedCT code identifying the kind of observation made about the patient.

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.
  • For each clinical statement that is an observation the usage of Observation.code is described below:
    • Patient Legal Status - the informal or Mental Health Act Section current at the time the message is created.
    • Living Will - The description of a living will in coded format.
    • Preferred Written Communication Requirements -  the patient's special requirements for written communication. 
    • Religious/Culturally Dependent Needs - a  patient's religious/cultural needs. 
    • Health & Social Issue as described by HCP - a type of issue, it's severity and status as identified by an HCP.
    • Health & Social Issue as described by patient - a type of issue, it's severity and status as identified by the patient.
    • Attitude of carer to issue - the carer's attitude to the issue.
    • Patient awareness of issue - the patient's awareness of the issue.
    • Carer awareness of issue - the carer's awareness of the issue.
    • Diagnosis - a diagnosis including certainty of diagnosis and negation.
    • Prognosis - a prognosis associated with a diagnosis.
    • Finding - a finding including any additional descriptions that can be coded.
    • Outcome - an outcome.
    • Goal - a goal identified for the future.
    • Family History - family history item, including description of relationship of person with family history to patient.
    • Risk Statement - an identified risk to others from the patient.
    • Risk Incident - the actual risk in a risk incident.
    • Smoking - the current status of the smoking habits of the patient including smoking consumption.
    • Smoking future intentions - the patient's future intentions to change smoking habits.
    • Alcohol - the alcohol status of the patient at the time of recording, includes alcohol consumption.
    • Alcohol future intentions - the patient's future intentions with regard to alcohol consumption.
    • Substance misuse - a known drug habit.
    • Exercise - the exercise habits of the patient.
    • Occupation - the patient's occupation .
    • Employment - information on the employment status of a patient Housing - information on the housing situation of the patient in coded form.
    • Social Network - the nature of the social network of the patient. Religion - information about the patient's religion.
    • Ethnic Category - information about the patient's ethnic category . 
    • Services - a type of service being provided by other agents to the patient.
    • Care provided by Carer - the nature of care provided by the carer to the patient.
    • Functioning and wellbeing - the functioning and wellbeing of the patient.
[1..1] statusCode (CS {CNE:ActStatus} )

The status of the observation.  It shall be a value taken from the HL7ActStatus vocabulary.

[1..1] effectiveTime (GTS)

Optional - not to be used in P1R2.

[0..1] activityTime (IVL<TS>)

The date and time the observation was made.

For each observation which has a requirement to carry the activity date and time the usage of Observation.activityTime is described below:

  • Health & Social Issue as described by HCP - The date and time that the problem was identified by the HCP - optional.
  • Prognosis - The date and time that the HCP made a diagnosis associated prognosis.
  • Family History - The date of stating the family history finding.
[0..1] availabilityTime (TS)

The time at which this observation was first recorded on a computer system.

[0..1] value (ANY)

A value associated with this observation, including any units involved.

ReasonForAbortRef

A reference to a statement acting as a reason

Used by: RequestMedicationSupplyAbortReasonChoice
[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:ActMood} )

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