Referral - tabular view

No Current Link To VocabularyCoded With ExtensionsCoded No Extensions
PRPA_RM030000UK06
Referral

A non-urgent referral from a HCP to an outpatient clinic.

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

Indicates that the act is for information and understanding.

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

Indicates that this is an event.

  • Fixed value "EVN"
[1..1] id (II)

This identifier is unique within the Choose and Book  Service. It identifies the Unique Booking Reference Number(UBRN) allocated to the service request associated with the referral. 

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

  • The root attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.1
  • The extension attribute shall contain the UBRN

[1..1] subject

Refers to the patient who is the subject of the referral.

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

Indicates that the role is that of subject.

[1..1] patient (Patient)

Information about the patient who is the subject.

[1..1] author

Refers to the referring HCP.

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

Indicates that the participant is the author of the referral.

  • Fixed value "SBJ"
[1..1] participant      [CMET: UKCT_MT120301UK02]

NPfIT CMET to identify a person fulfilling a specific role where the Person, Role Profile and Job Role are all mandatory. Full details of the person, role profile and job role are available from SDS.

[1..*] component2

Refers to the clinical information items contained in the referral.

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

Indicates that this is a component of the referral.

  • Fixed value "COMP"
[1..1] target (ReferralComponent)

Information about a clinical information item in the referral.

[1..*] component1

Refers to a set of headings which categorise the clinical information items in the referral.

Each clinical information item may be categorised by one or more headings.

Each clinical information item shall be categorised by at least one heading.

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

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] categoryHeader (CategoryHeader)

Information about a specific referral category heading.

[1..*] pertinentInformation

Information about a kind of action requested by the referral. 

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

Indicates pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentRequestedAction (RequestedAction)

Information about the requested kind of action. 

Patient

Details about the patient.

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

Indicates that the role is that of a patient.

  • Fixed value "PAT"
[1..1] id (II)
To provide the nationally recognised identifier for the patient, the NHS number.

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

An NHS number is carried in the following way:

  • The root attribute will contain an OID with the value "2.16.840.1.113883.2.1.4.1"
  • The extension attribute will contain the NHS number.

Only new permanent NHS numbers can be used to identify patients.

.

[0..1] patientPerson (Person)

Information about the person who is the identified patient.

ReferralComponent

A choice of items that are components of a category within a referral.

Used by: ReferralCompoundStatement
[0..*] performer

Refers to a performer of an act that is a component of the referral.

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

Indicates that this is a performer.

  • Fixed value: "PRF"
[1..1] participant (UKCT_MT120301UK02)
[1..1] either : CompoundStatement

A compound statement may be nested within another compound statement .This enables components to be linked within a category heading.

             ... or ... : Medication

A record containing medication information relevant to one or more category heading.

             ... or ... : NarrativeStatement

A record containing uncategorised text relevant to one or more category headings. This should be text that cannot be carried elsewhere.

             ... or ... : ObservationStatement

A record containing observation details relevant to one or more category heading.

             ... or ... : ProcedureEvent

A record containing details about a procedure relevant  to one or more category heading.

CategoryHeader

Details about a category header.

Each category header may only appear once.

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

Indicates that this 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] id (II)

A unique identifier for this instance of a category header. 

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

  • A UUID is held in the root attribute

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

A code describing the category heading.

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the ReferralCategoryHeading vocabulary;
  • The codeSystem attribute will contain the OID referenced in the ReferralCategoryHeading  vocabulary

.

[1..*] component

References to the set of clinical information items that exist within a specific category header.

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

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] actRef (ActRef)

Information about a clinical information item within a category header.

RequestedAction

Description of the action requested by the referral.

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

Indicates that this is an act.

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

Indicates that this is a request.

  • Fixed value: "RQO"
[1..1] code (CV {CNE:ServiceTypeRequested} )

A code describing the action requested within the referral.

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute will contain a value from the list of codes in the ServiceTypeRequested vocabulary;
  • The codeSystem attribute will contain the OID referenced in the ServiceTypeRequested  vocabulary
[0..1] text (ST)

Additional text that is not carried within the code attribute. It SHALL NOT contradict any coded information.

Person

Details about the person who is the patient.

Used by: Patient
[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"
[0..1] religiousAffiliationCode (CV {CNE:ReligiousAffiliation} )

The primary religious preference of the patient (e.g. Hinduism, Islam, Roman Catholic Church) in coded form.

The Coded with Code System datatype flavour is used to carry this information as follows

  • The code attribute will contain a value from the list of codes in the ReligiousAffiliation vocabulary;
  • The codeSystem attribute will contain the OID referenced in the ReligiousAffiliation  vocabulary
[0..1] ethnicGroupCode (CV {CNE:EthnicCategory} )

The ethnic category of the patient represented in coded form.

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the EthnicCategory vocabulary.
  • The codeSystem attribute will contain the OID referenced in the EthnicCategory  vocabulary
CompoundStatement

A compound statement contains a collection of other referral components.

All referral components within a compound statement shall belong under the same category header. 

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

Indicates that this 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] id (II)

A unique identifier for this instance of a compound statement component. 

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

  • A UUID is held in the root attribute

[1..1] code (CD {CNE:EhrCompoundCode} )

A code naming the collection of components in this Compound.

The vocabulary that this code value is taken from depends upon the value of the CompoundStatement.levelCode attribute as defined below.

1.  CompoundStatement.levelCode is "9b40." (Topic)

  • The CompoundStatement.EhrCompoundCode is a clinical code that describes a topic within a single encounter or composition. 

2.  CompoundStatement.levelCode is "9b41." (Category)

  • The CompoundStatement.EhrCompoundCode is a consultation category code that names sections of an encounter record or composition.

3.  CompoundStatement.levelCode is "9b42." (Cluster)

  • The CompoundStatement.EhrCompoundCode is a clinical code representing the contents of the cluster  (e.g. "Haematology investigations").

4.  CompoundStatement.levelCode is "9b43." (Battery)

  • The CompoundStatement.EhrCompoundCode is a clinical code representing the name of the overall investigation (e.g. "Blood Pressure", "Full blood count").

Any of the Concept Descriptor datatype flavours can be used and will include the following attributes:

  • The code attribute shall contain a value 
  • The codeSystem attribute shall contain an OID as defined below.

The data fields in the message are constructed to support future strategic use of SNOMED CT codes. If these codes are not currently available to populate the message, a suitable alternative from an identified coding scheme should be found. Valid coding schemes are as follows:

The Read Codes Version 2, OID is 2.16.840.1.113883.2.1.6.2
The Read Codes Four Byte Set, OID is 2.16.840.1.113883.2.1.6.1
Clinical Terms (Read Codes) v3, OID is 2.16.840.1.113883.2.1.3.2.4.14
SNOMED CT UK, OID is 2.16.840.1.113883.2.1.3.2.4.15
Egton Codes, OID is 2.16.840.1.113883.2.1.6.3,
EMIS Drug Codes, OID is 2.16.840.1.113883.2.1.6.9
[1..1] statusCode (CS {CNE:completed} )

Indicates the status of the component. The fixed value shall be "completed".

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

The clinically relevant date and time.

Eg. For an investigation result it is the time of sampling or undertaking an examination not the time of analysis or reporting.

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

This is the time when the observations or actions recorded in the Compound actually took place.

[1..1] availabilityTime (TS)

System date and time of recording this observation on the original system.

[0..1] priorityCode (CV {CNE:PriorityType} )

An optional indicator in coded form of the priority assigned to actions described within this compound. For example where the compound represents a battery of requests or observations.

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the PriorityType vocabulary.
  • The codeSystem attribute will contain the OID referenced in the PriorityType  vocabulary
[1..1] levelCode (CV {CNE:EhrCompoundLevel} )

Indicates using a code whether this compound contains items that are part of a:

  • Topic ("9b40.") - A subdivision of a Composition related to a particular clinical issue.
  • Category ("9b41.") - A subdivision of a Composition or Topic containing similar elements (e.g. Subjective, Objective, Assessment, Plan)
  • Cluster ("9b42.") - A subdivision of a Composition, Topic or Category containing closely related Statements and or Batteries.(e.g. a series of Blood Pressure readings, a combination of a Full Blood Count and ESR).
  • Battery ("9b43.") - A subdivision of a Composition, Topic, Category  or Cluster containing Statements that comprise the observations from an identifiable investigation (e.g. Blood Pressure, Full Blood Count, Electrolytes and Urea).

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the EhrCompoundLevel vocabulary.
  • The codeSystem attribute will contain the OID referenced in the EhrCompoundLevel  vocabulary
[0..1] uncertaintyCode (CS {CNE:ActUncertainty} )

Allows the author to indicate using a code that the components within a statement are in some way uncertain.

The Coded with Code System datatype flavour is used to carry this information as follows:

  • The code attribute shall contain a value from the list of codes in the ActUncertainty vocabulary.
[0..1] interpretationCode (CV {CNE:Interpretation} )

A code indicating whether a set of observations were interpreted as abnormal by the party responsible for undertaking the original observations.

Note

  • The primary intended use of this is for representation of laboratory investigations in line with current UK clinical EDI requirements.

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

  • The code attribute shall contain a value from the list of codes in the Interpretation vocabulary.
  • The codeSystem attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.16.8
  • The displayName attribute shall contain the text description of the code. 
[1..*] component

The compound statement shall contain one or more other components chosen from the referral component. All the components shall be categorised by the same category heading.

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

Indicates that this is a component.

  • Fixed value: "COMP"
[1..1] target (ReferralComponent)

Information about a clinical information item in the referral.

'The content of a CompoundStatement is one or more components taken from the choice class containing it.   The following constraint limits the nesting of CompoundStatements.
  • The levelCode values represent a set of descending levels in the following order:
    • "9b40."  Topic
      • "9b41."  Category
        • "9b42."  Cluster
          • "9b43."  Battery
  • A Compound may contain one or more Compounds from any lower level.
  • A Compound may not contain any other Compounds from the same level or from any higher level.
Medication

Details about relevant medication that is being taken by the patient or has been taken.

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

Indicates that this component relates to substance administration.

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

Indicates that this is an event.

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

A unique identifier for this instance of a medication component. 

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

  • A UUID is held in the root attribute
[1..1] code (CV {CNE:MedicationActType} )

A code representing the medication.

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

Date/time or period of intended or actual treatment.

[0..1] activityTime (TS)

The date of prescription of the medication.

[0..1] routeCode (CE {CNE:RouteOfAdministration} )

The route of administration of the drug.

[0..1] doseQuantity (PQ)

The quantity supplied.

[0..1] maxDoseQuantity (PQ)

The maximum daily dose. This is given in terms of value and units.

[1..1] consumable

Refers to the substance of the medication. 

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

Indicates that this is a consumable.

  • Fixed value: "CSM"
[1..1] medicine (Medicine)

Information about the drug that is the medication.

[0..1] component

Refers to the quantity of medication supplied.

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

Indicates that this is a component of the medication.

  • Fixed value "COMP"
[1..1] supplyEvent (SupplyEvent)

The quantity of medication supplied.

[0..1] pertinentInformation2

Refers to the dosage carried as unstructured data.

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

Indicates  that this is pertinent to the medication component.

  • Fixed value "PERT"
[1..1] pertinentMedicationDosage (MedicationDosage)

The unstructured dosage text.

[0..1] pertinentInformation4

Refers to the medication reveiw required indicator.

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

Indicates  that this is pertinent to the medication component.

  • Fixed value "PERT"
[1..1] pertinentMedicationReviewReq (MedicationReviewReq)

The medication review required indicator

[0..1] pertinentInformation1

Refers to the timing of the medication.

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

Indicates  that this is pertinent to the medication component.

  • Fixed value "PERT"
[1..1] pertinentMedicationTiming (MedicationTiming)

The timing of the medication.

[0..*] pertinentInformation3

Refers to the trigger for administering the medication.

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

Indicates  that this is pertinent to the medication component.

  • Fixed value "PERT"
[1..1] pertinentMedicationAdminTrigger (MedicationAdminTrigger)

The trigger for administration.

[0..1] pertinentInformation5

Refers to free text associated with the medication details.

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

Indicates  that this is pertinent to the medication component.

  • Fixed value: "PERT"
[1..1] pertinentMedicationCommentary (MedicationCommentary)

Free text comment about the medication.

NarrativeStatement

The Narrative statements exists to accommodate referral information which is not semantically processable by a computer system. 

The reason that the information is presented in this form may be:

  • That it is not semantically processable in the sending system.
  • That the semantics in the sending system cannot be reliably represented in the message
  • That the information has been degraded from a semantically processable form to allow receipt by an application that does not support the semantics of the sending system.
Used by: ReferralCompoundStatementReferralComponent
[1..1] classCode (CS {CNE:OBS} ){ Fixed="OBS " }

Indicates that this 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] id (II)

A unique identifier for this instance of a narrative statement component. 

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

  • A UUID is held in the root attribute

Example

<id root="41CB01EC-8794-4B9B-ADC4-AB5BD0954EBE"/>

[1..1] text (ED)

The marked up text content of the Narrative.

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

Indicates the status of the component. In this context the status shall be "completed".

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

  • The code attribute shall default to "completed"
[0..1] availabilityTime (TS)

System date and time of recording this narrative on the original system.

ObservationStatement

An observation statement is used to carry most elements of a referral. This includes problem being referred, investigations, examinations, diagnoses, social history and family history. 

There shall be an observation statement that carries the problem being referred.

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

Indicates that this 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] id (II)

A unique identifier for this instance of an observation component. 

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

  • A UUID is held in the root attribute
[1..1] code (CD {CNE:ObservationCode} )

A code specifying the nature of the observation.

Observation shall be coded with additional information held in Observation Commentary.

Any of the Concept Descriptor datatype flavours can be used and will include the following attributes:

  • The code attribute shall contain a value 
  • The codeSystem attribute shall contain an OID as defined below.

The data fields in the message are constructed to support future strategic use of SNOMED CT codes. If these codes are not currently available to populate the message, a suitable alternative from an identified coding scheme should be found. Valid coding schemes are as follows:

The Read Codes Version 2, OID is 2.16.840.1.113883.2.1.6.2
The Read Codes Four Byte Set, OID is 2.16.840.1.113883.2.1.6.1
Clinical Terms (Read Codes) v3, OID is 2.16.840.1.113883.2.1.3.2.4.14
SNOMED CT UK, OID is 2.16.840.1.113883.2.1.3.2.4.15
Egton Codes, OID is 2.16.840.1.113883.2.1.6.3,
EMIS Drug Codes, OID is 2.16.840.1.113883.2.1.6.9
[0..1] text (ST)

Text specifying the nature of the observation.

Text shall only be used if no code value is available and SHALL NOT be used in conjunction with Observation Commentary.

[0..1] effectiveTime (TS)

The clinically relevant date and time.

Eg. For an investigation result it is the time of sampling  not the time of analysis or reporting.

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

Date/time of the observation.

[0..1] uncertaintyCode (CS {CNE:ActUncertainty} )

Allows the author to indicate using a code that the components within a statement are in some way uncertain.

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 ActUncertainty vocabulary.
[0..1] value (ANY)

The result value of an observation action.The result value of an observation action. The following are the approved uses for clinical observations within the NPfIT:

Quantitative measurement - PQ::Physical quantity (real number with unit.  This includes time periods, e.g. 30 minutes, 2 days)

Titre (eg.,1:64) and other ratios - RTO :: A ratio of two integer numbers

Index (number without unit) - PQ with a dimensionless unit (e.g., an integer or real number

 Ranges (eg.,<3;12-20) - IVL<PQ> :: Interval of physical quantity)

Ordinals (eg.,stage lIa. ++) - CO - coded ordinals

Non-ordinal Values represented using a controlled terminology  (e.g. organism type shigella.. Note such values are of the concept given by the observation.code, and do not replace it.

CV, with mandatory code & coding system id, version id required (i.e. must be used where relevant), display name optional, original text not applicable, and code system name optional .  This would include binary codes, which should be given more specific meaning such as present / absent, true / false by this means.

Uncoded nominal results (eg.,organism type)

ST a string (This representation is deprecated, and CV should be used in it's stead wherever possible)

Blobs(images, scanned documents, biosignals, audio recordings)

ED - the reference and thumbnail properties are not applicable

[0..1] interpretationCode (CV {CNE:Interpretation} )

A code indicating whether a set of observations were interpreted as abnormal by the party responsible for undertaking the original observations.

Note

  • The primary intended use of this is for representation of laboratory investigations in line with current UK clinical EDI requirements.

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

  • The code attribute shall contain a value from the list of codes in the Interpretation vocabulary.
  • The codeSystem attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.16.8
  • The displayName attribute shall contain the text description of the code. 
[0..1] pertinentInformation

Refers to notes/comments about an observation

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

Indicates pertinent information.

  • Fixed value: "PERT"
[1..1] pertinentObservationCommentary (ObservationCommentary)

Comments/notes about an observation.

[0..*] referenceRange

Refers to normal reference ranges for a laboratory result.

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

Indicates that there are reference values.

  • Fixed value: "AOR"
[1..1] referenceNormalRange (NormalRange)

Information about the normal reference range for a laboratory result.

ProcedureEvent

Details about a procedure.

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

Indicates that this is a procedure.

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

Indicates that this is an event.

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

A unique identifier for this instance of an procedure event component. 

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

  • A UUID is held in the root attribute
[1..1] code (CD {CNE:ProcedureCode} )

Procedure shall be coded with additional information held in Procedure Commentary

Any of the Concept Descriptor datatype flavours can be used and will include the following attributes:

  • The code attribute shall contain a value 
  • The codeSystem attribute shall contain an OID as defined below.

The data fields in the message are constructed to support future strategic use of SNOMED CT codes. If these codes are not currently available to populate the message, a suitable alternative from an identified coding scheme should be found. Valid coding schemes are as follows:

The Read Codes Version 2, OID is 2.16.840.1.113883.2.1.6.2
The Read Codes Four Byte Set, OID is 2.16.840.1.113883.2.1.6.1
Clinical Terms (Read Codes) v3, OID is 2.16.840.1.113883.2.1.3.2.4.14
SNOMED CT UK, OID is 2.16.840.1.113883.2.1.3.2.4.15
Egton Codes, OID is 2.16.840.1.113883.2.1.6.3,
EMIS Drug Codes, OID is 2.16.840.1.113883.2.1.6.9
[0..1] text (ST)

Text specifying the nature of the procedure.

Text shall only be used if no code value is available and SHALL NOT be used in conjunction with Procedure Commentary.

[0..1] effectiveTime (TS)

The clinically relevant date and time.

Eg. This is the time of undertaking an examination not the time of reporting.

[0..1] pertinentInformation

Refers to notes/comments about a procedure.

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

Indicates information pertinent to a procedure.

  • Fixed value "PERT"
[1..1] pertinentProcedureCommentary (ProcedureCommentary)

Comments/notes about a procedure.

ActRef

Refers to a component using a unique identifier.

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

Indicates that this is an act.

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

Indicates that this is an event.

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

A unique identifier for this instance of a referral component. 

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

  • A UUID is held in the root attribute
Medicine

Details about the drug

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

 Indicates that this is a manufactured material.

  • Fixed value: "THER"
[1..1] manufacturedSubstance (Substance)

Information about the substance that forms the medication.

SupplyEvent

Details about the amount of medication supplied. 

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

Indicates that the drug is supplied.

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

Indicates that this is an event.

  • Fixed value: "EVN"
[1..1] quantity (PQ)

The total amount of drug quantity supplied.

MedicationDosage

The dosage carried as unstructured text.

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

Indicates that this act relates to substance administration.

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

Indicates that this is an event.

  • Fixed value: "EVN"
[1..1] text (ST)

Carries all dosage information.

A text string should be composed if any items cannot be coded and SHALL NOT be used in conjunction with structured information.

MedicationReviewReq

The medication review required indicator. 

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

Indicates that this is an observation within a medication component.

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

Indicates that this is an event.

  • Fixed value: "EVN"
[1..1] code (CS {CNE:ActCode} )

A code describing the act. In this context the value shall be "ReviewRequired"

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

  • The code attribute shall default to "ReviewRequired"
[1..1] value (BL)

A value indicating whether a medication review is required. 

 The value attribute may be "false" indicating that no review is required,  or "true" indicating that a review is required.

MedicationTiming

Details of the times of administration of the medication.

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

Indicates that this relates to substance administration.

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

Indicates that this is an event.

  • Fixed value: "EVN"
[1..1] text (ST)

Text string allowing full description of administration times.

eg. Three times a day after meals.

MedicationAdminTrigger

Describes the trigger for administrating medication.

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

Indicates that this relates to substance administration.

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

Indicates that this is an event.

  • Fixed value: "EVN"
[1..1] text (ST)

Text string describing the trigger for administering medication.

MedicationCommentary

Comments/notes about the medication component.

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

Indicates that this is an observation within a medication component.

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

Indicates that this is an event.

  • Fixed value: "EVN"
[1..1] text (ST)

Additional comments about a medication component. 

This SHALL NOT contradict any coded information.

ObservationCommentary

Comments/notes about an observation.

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

Indicates that this 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] text (ST)

Additional comments about an observation. 

This SHALL NOT contradict any coded information.

NormalRange

Details of normal reference ranges.

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

Indicates that this is an observation.

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

Indicates that this is an event.

  • Fixed value: "EVN.CRT"
[0..1] text (ED)

A textual comment on the reference range.

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

The reference range values.

[0..1] interpretationCode (CV {CNE:Interpretation} )

A code indicating whether a set of observations were interpreted as abnormal by the party responsible for undertaking the original observations.

Note

  • The primary intended use of this is for representation of laboratory investigations in line with current UK clinical EDI requirements.

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

  • The code attribute shall contain a value from the list of codes in the Interpretation vocabulary.
  • The codeSystem attribute shall contain an OID with the value 2.16.840.1.113883.2.1.3.2.4.16.8
  • The displayName attribute shall contain the text description of the code. 
ProcedureCommentary

Comments/notes about a procedure.

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

Indicates that this 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] text (ST)

Additional comments about a procedure. 

This SHALL NOT contradict any coded information.

Substance

Details about the drug.

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

Indicates that this is a manufactured material.

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

Indicates that the entity is a general description of a kind of thing.

  • Fixed value: "KIND"
[1..1] code (CE {CNE:Substance} )

A code specifying the nature of the substance.

Any of the Concept Descriptor datatype flavours can be used and will include the following attributes:

  • The code attribute shall contain a value 
  • The codeSystem attribute shall contain an OID as defined below.

The data fields in the message are constructed to support future strategic use of SNOMED CT codes. If these codes are not currently available to populate the message, a suitable alternative from an identified coding scheme should be found. Valid coding schemes are as follows:

The Read Codes Version 2, OID is 2.16.840.1.113883.2.1.6.2
The Read Codes Four Byte Set, OID is 2.16.840.1.113883.2.1.6.1
Clinical Terms (Read Codes) v3, OID is 2.16.840.1.113883.2.1.3.2.4.14
SNOMED CT UK, OID is 2.16.840.1.113883.2.1.3.2.4.15
Egton Codes, OID is 2.16.840.1.113883.2.1.6.3,
EMIS Drug Codes, OID is 2.16.840.1.113883.2.1.6.9
[0..1] quantity (PQ)

The strength of the drug.

[1..1] name (ST)

The name of the drug.

[0..1] formCode (CE {CNE:ClinicalProductForm} )

A code specifying the drug formulation.

Any of the Concept Descriptor datatype flavours can be used and will include the following attributes:

  • The code attribute shall contain a value 
  • The codeSystem attribute shall contain an OID as defined below.

The data fields in the message are constructed to support future strategic use of SNOMED CT codes. If these codes are not currently available to populate the message, a suitable alternative from an identified coding scheme should be found. Valid coding schemes are as follows:

The Read Codes Version 2, OID is 2.16.840.1.113883.2.1.6.2
The Read Codes Four Byte Set, OID is 2.16.840.1.113883.2.1.6.1
Clinical Terms (Read Codes) v3, OID is 2.16.840.1.113883.2.1.3.2.4.14
SNOMED CT UK, OID is 2.16.840.1.113883.2.1.3.2.4.15
Egton Codes, OID is 2.16.840.1.113883.2.1.6.3,
EMIS Drug Codes, OID is 2.16.840.1.113883.2.1.6.9