A_Recommend - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
UKCT_RM140100UK01
RecommendationChoice
A choice of the kinds of recommendation statement available for medication.
Used by:
[0..1] author

The participation of the agent / device / person who authored this recommendation.  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

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

The agent / device / person performing this participation.

[0..1] primaryInformationRecipient
A link to the optional person intended to receive the recommendation.
[1..1] typeCode (CS {CNE:PRCP} ){ Fixed="PRCP " }

Indicates that this is a primary information recipient relationship.

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

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 recommendation is directed

[0..*] tracker
A link to an organisation / person to which a copy of this recommendation is to be sent.
[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)

An organisation / person to which a copy of this recommendation is to be sent.

[0..1] pertinentInformation5

An optional relationship to a textual representation of the reason for making this recommendation..

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

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] pertinentReasonSupportingInfo (ReasonSupportingInfo)

The reason for making this recommendation.

[0..1] pertinentInformation6

Relates the recommendation to its (optional) review date.

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

The source act not intended to be interpreted independently and the value shall be fixed at 'false'.

[1..1] pertinentRecommendationReviewdate (RecommendationReviewdate)

The date at which this recommendation should be reviewed.

[0..*] reason

A link to zero or more references to clinical statements / clinical statements that justify the medication recommendation.  It therefore may also be the reason the recommendation was cancelled /aborted

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

Indicates that the relationship type is 'reason for'.

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 and  true, 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 defaults to "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 .

[0..*] sourceOf

A 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 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] target (ActRef)

The clinical statement being referred to.

[1..1] either : RecommendAvoidMedication

A recommendation that a medication should not be administered (or supplied)

             ... or ... : RecommendDiscontinueMedicationAdministration

A recommendation that a medication administration should be discontinued.

             ... or ... : RecommendDosageChange

A recommendation nthat a dosage of a medication administration should be changed.

             ... or ... : RecommendMaintainMedication

A recommendation that a medication being administered should be continued

             ... or ... : RecommendMedicationAdministration

A recommendation that a medication should be administered.

             ... or ... : RecommendMedicationSubstitution

A recommendation that one medication should be substituted for another used in planned  / requested / in progress administration.

RecommendAvoidMedication

A recommendation that a medication should not be administered (or supplied)

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

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

A  SnomedCT code identifying the act as describing avoiding a 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 status of the recommendation.. It shall consist of a value taken from the HL7 ActStatus vocabulary that is one of the following:

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

Optional - not for use in P1R2.  The time when the recommendation is to take effect...

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

Optional - the time when the recommendation attained it's current status.

[0..1] availabilityTime (TS)

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

[1..1] consumable
A link to the medication to be avoided.
[1..1] typeCode (CS {CNE:CSM} ){ Fixed="CSM " }

Indicates that the role is that of a consumable

  • Fixed value: "CSM"
[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 (RecommendedMedication)

The medication to be avoided.

RecommendDiscontinueMedicationAdministration

A recommendation that a medication administration should be discontinued.

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

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

A  SnomedCT code identifying the act as describing discontinuing a 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 status of the recommendation.  It shall consist of a value taken from the HL7 ActStatus vocabulary that is one of the following:

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

Optional - not for use in P1R2.  The time when the recommendation is to take effect...

[0..1] availabilityTime (TS)

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

[0..1] pertinentInformation
A link to a textual description of when to stop administering the medication, e.g. at once / when current stock exhausted / when all authorised supply exhausted.  It may also include a text form of a recommended stop date.
[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  "true".

[1..1] pertinentWhenToDiscontinue (WhenToDiscontinue)

The textual description of when to stop taking the medication.

[1..1] sequelTo
A link to a reference to the planned / requested medication administration which it is recommended to discontinue.
[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 "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] priorAdministerMedicationRef (AdministerMedicationRef)

The planned / requested medication administation which it is rcommended to discontinue.

RecommendDosageChange

A recommendation that the dosage of a medication requested / being administered should be changed.

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

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

A  SnomedCT code identifying the act as changing the dosage of a medication administration.. 

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 status of the recommendation..  It shall consist of a value taken from the HL7 ActStatus vocabulary that is one of the following:

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

Optional - not for use in P1R2.  The time when the recommendation is to take effect...

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

Optional - the time when the recommendation attained it's current status.

[0..1] availabilityTime (TS)

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

[0..1] doseQuantity (IVL<PQ>)

Optional - the revised dose, including unit of dosage

[0..1] rateQuantity (IVL<PQ>)

Optional - the revised dosage rate, including units.

[1..1] pertinentInformation2
A link to the dosage instructions being recommended.
[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'.The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "false".

[1..1] pertinentDosageInstructions (DosageInstructions)

The dosage instructions being recommended.

[0..*] pertinentInformation1
A link to any additional dosage instructions being recommended.
[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'.The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "false".

[1..1] pertinentAdditionalInstructions (AdditionalInstructions)

The additional dosage instructions being recommended.

[1..1] sequelTo
A link to a reference to the medication administration whose dosage is being revised.
[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 "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] priorAdministerMedicationRef (AdministerMedicationRef)

The medication administration whose dosage is being revised.

RecommendMaintainMedication

A recommended that the administration of a medication should continue.

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

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

A  SnomedCT code identifying the act as describing maintaining medication administration. 

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 status of the recommendation..  It shall consist of a value taken from the HL7 ActStatus vocabulary that is one of the following:

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

Optional - not for use in P1R2.  The time when the recommendation is to take effect.

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

Optional - the time when the recommendation attained its current status.

[0..1] availabilityTime (TS)

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

[1..1] sequelTo

A link to a reference to the medication administration being maintained

[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 "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] priorAdministerMedicationRef (AdministerMedicationRef)

The medication administration nbeing maintained.

RecommendMedicationAdministration
A recommendation that a specific medication should be administered.
Used by: RecommendationChoice
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM " }

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

A  SnomedCT code identifying the act as describing medication administration. 

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 status of the recommendation..  It shall consist of a value taken from the HL7 ActStatus vocabulary that is one of the following:

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

Optional - not for use in P1R2.  The time when the recommendation is to take effect.

[0..1] availabilityTime (TS)

Optional - the time when the recommendation attained its current status.

[0..1] doseQuantity (IVL<PQ>)

Optional - the dose, including unit of dosage

[0..1] rateQuantity (IVL<PQ>)

Optional - the dosage rate, including units.

[1..1] consumable

The medicinal product whose administration is being recommended.

[0..*] pertinentInformation1
A link to the additional dosage instructions for this recommended administration.
[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 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] pertinentAdditionalInstructions (AdditionalInstructions)

The additional dosage instructions for this recommended administration.

[0..1] pertinentInformation2
A link to the dosage instructions for the recomended medication administration.
[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'.The value of seperatableInd shall be evaluated for each usage of the pertinentInformation relationship.

In this context the seperatableInd defaults to "false".

[1..1] pertinentDosageInstructions (DosageInstructions)

The dosage instructions for the recomended medication administration.

[0..1] sequelTo
An optional link to a reference to any preceding medication administration recommendation that this recommendation is superseding.
[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 "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] priorRecommendationRef (RecommendationRef)

A preceding medication administration recommendation that this recommendation is superseding.

RecommendMedicationSubstitution

A recommendation that one medication should be substituted for another used in planned  / requested / in progress administration.

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

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

A  SnomedCT code identifying the act as describing substitution of one medication for another. 

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 status of the recommendation.. It shall consist of a value taken from the HL7 ActStatus vocabulary that is one of the following:

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

Optional - not for use in P1R2.  The time when the recommendation is to take effect.

[0..1] availabilityTime (TS)

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

[0..1] doseQuantity (IVL<PQ>)

Optional - the revised dose, including unit of dosage

[0..1] rateQuantity (IVL<PQ>)

Optional - the revised dosage rate, including units.

[1..1] pertinentInformation
A link to the new planned medication administration being recommended.
[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] pertinentPlanMedicationAdministration      [CMET: UKCT_MT140301UK01]

The new planned medication administration being recommended.

[1..1] sequelTo
A link to a reference to the planned / requested medication administration whose replacement is being recommended.
[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 "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] priorMedicationAdministrationRef (MedicationAdministrationRef)

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

RoleChoice

The agent / device / person performing this participation.

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

PrimaryRecipient

The agent / device / person performing this participation.

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

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

             ... or ... : UKCT_MT120301UK02

The agent / device / person performing this participation.

CopyRecipient

The agent / device / person performing this participation.

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

The agent / device / person performing this participation.

             ... or ... : UKCT_MT120201UK03

The agent / device / person performing this participation.

ReasonSupportingInfo

A textual representation of the reason(s) formaking this medication recommendation.

Used by: RecommendationChoice
[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 for making a medication recommendation.

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

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

A string containing the reason for making the recommendation

RecommendationReviewdate

A textual representation of the recommendation review date.

Used by: RecommendationChoice
[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 value from the PrescriptionAnnotation vocabulary identifying that this is a rcommendation review date.

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

  • The code attribute shall contain a fixed value of "RD"
  • The code System attribute shall contain the OID for the vocabulary concerned. 
[0..1] effectiveTime (GTS)

Optional - not to be used in P1R2. 

[1..1] value (ST)

The review date / period / interval in textual form.

ReasonChoice

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

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

An observation acting as a reason

             ... or ... : ReasonRef

A reference to any act acting as a reason.

ActRef

A reference to any other clnical statement.

Used by: RecommendationChoice
[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
NonAgentRole

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

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

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

Observation

An observation acting as a reason for the recommendation being made, or ending in an abnormal state.

Used by: RecommendationChoice, ReasonChoice
[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)

The clinically relevant date and time.

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

  • Patient Legal Status - The start and end date of the latest legal status of the patient - optional. 
  • Health & Social Issue as described by patient - The date that the patient noticed the issue and the date that the issue was resolved - optional.
  • Diagnosis - The date and time the diagnosis was true of the patient - optional
  • Finding - the date and time the finding was true of the patient - optional
  • Outcome - The date and time the outcome was assessed - optional.
  • Risk Incident - The date and time that the incident occurred - optional.

A date range shall be carried as follows:

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

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

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

  • The low attribute shall contain the start date.

If only an end date is present the Date or Time Interval Before datatype shall be used:

  • The high attribute shall contain the end date.

If the observation occurs more than once, multiple dates / date ranges shall be recorded.

[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 rfirst ecorded on a computer system.

[0..1] value (ANY)

The value of the observation.

ReasonRef

A reference to any act acting as a reason.

Used by: RecommendationChoice, ReasonChoice
[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
RecommendedMedication

The agent / device / person performing this participation.

Used by: RecommendAvoidMedication
[1..1] either : ManufacturedProduct

The agent / device / person performing this participation.

             ... or ... : MaterialCategory

The agent / device / person performing this participation.

WhenToDiscontinue

A textual representation of when to discontinue medication administration.

Used by: RecommendDiscontinueMedicationAdministration
[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 value from the PrescriptionAnnotation vocabulary identifying this as when to discontinue a medication administration. 

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

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

A reference to a planned / requested medication administration.

Used by: RecommendDiscontinueMedicationAdministration, RecommendDosageChange, RecommendMaintainMedication
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM " }

Indicates the act is dealing with substance administration.

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

Indicates the mood of the act.  It shall contain a value taken from the HL7 ActMood vocabulary, and shall be either "IN" (intended") or  "RQO" (requested).

[1..1] id (II)

The unique national identifier 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
DosageInstructions

The planned dosage instructions for this medication administration.

Used by: RecommendDosageChange, RecommendMedicationAdministration
[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 taken from the PrescriptionAnnotation vocabulary indicating that this act contains the dosage instructions.

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

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

The dosage instructions in text form.

AdditionalInstructions

Additional instructions for the patient in human readable form.

Used by: RecommendDosageChange, RecommendMedicationAdministration
[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} )

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

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

The (additional?)d osage instructions in human-readable form.

RecommendationRef
A reference to an existing recommendation to administer medication.
Used by: RecommendMedicationAdministration
[1..1] classCode (CS {CNE:SBADM} ){ Fixed="SBADM " }

Indicates the act is dealing with substance administration.

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

Indicates the act is in the "proposed" mood.

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

The unique national identifier 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
MedicationAdministrationRef

The RequestMedicationAdministration / PlanMedicationAdministration that this dose administration is fulfilling.

Used by: RecommendMedicationSubstitution
[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
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..1] name (PN)

The name of the person

ManufacturedProduct

The role that plays the manufactured product.

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

Indicates a role scoped by a manufacturer.

  • Fixed value: "MANU"
[1..1] manufacturedManufacturedMaterial (ManufacturedMaterial)

Information about the manufactured material that is the medication being administered

MaterialCategory

A category of medication being recommended, e.g. a beta-blocker, steroid, amoxycillin

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

Indicates that this class is a role of a manufactured material.

[1..1] code (CE {CNE:DrugCategorySnCT} )

A category of medication represented using SnomedCT.

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.
ManufacturedMaterial
The type of medication being administered
Used by: ManufacturedProduct
[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.