There are 5 COVID SNOMED CT terms that act as triggers in the Summary Care Record Application (SCRa) to trigger the displaying of warning boxes.These codes are documented on the Coronavirus (COVID-19) message in SCR page on the NHS Digital website.
The 5 codes are
| Concept | Preferred term | SCR Section |
|---|---|---|
| 1240751000000100 | COVID-19 | Diagnoses |
| 1300721000000109 | COVID-19 confirmed by laboratory test | Diagnoses |
| 1240581000000104 | SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive | Clinical Observations and Findings |
| 1300731000000106 | COVID-19 confirmed using clinical diagnostic criteria | Diagnoses |
| 1240761000000102 | Suspected COVID-19 | Diagnoses |
Within the HL7v3 model, all coded entries originate from the same link class (pertinentInformation2). For each of the SCR Section types will have the same XML to cover the HL7v3 model from the link class pertinentInformation2 through to the component link off the relevant CMET (Diagnosis or Investigation Results OR Clinical Observations and Findings)
The only data item that varies between the CMET choice is the value of pertinentInformation2\pertinentCREType\code - which holds the relevant CREType code. The rest of the values used in the HL7v3 model are all fixed values. None of these values have any FHIR mapping - other than the CREType selected for the HL7v3 will indicate which FHIR resource should be used.
Note: pertinentInformation2 repeats for each type of CREType
| Mapping | ||
|---|---|---|
| Item | @typeCode | |
| HL7v3 | pertinentInformation2@typeCode | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "PERT" | |
| Item | @inversionInd | |
| HL7v3 | pertinentInformation2@inversionInd | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "false" | |
| Item | @contextConductionInd | |
| HL7v3 | pertinentInformation2@contextConductionInd | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "true" | |
| Item | @negationInd | |
| HL7v3 | pertinentInformation2@negationInd | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "false" | |
| Item | templateId@root | |
| HL7v3 | pertinentInformation2@templateId@root | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "2.16.840.1.113883.2.1.3.2.4.18.2" | |
| Item | templateId@extension | |
| HL7v3 | pertinentInformation2\templateId@extension | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "CSAB_RM-NPfITUK10.pertinentInformation1" | |
| Item | seperatableInd@value | |
| HL7v3 | pertinentInformation2\seperatableInd@value | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "true" |
<pertinentInformation2 typeCode="PERT" inversionInd="false" contextConductionInd="true" negationInd="false"> <templateId root="2.16.840.1.113883.2.1.3.2.4.18.2" extension="CSAB_RM-NPfITUK10.pertinentInformation1"/> <seperatableInd value="true"/>
| Mapping | ||
|---|---|---|
| Item | @classCode | |
| HL7v3 | pertinentCREType@classCode | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "CATEGORY" | |
| Item | @moodCode | |
| HL7v3 | pertinentCREType@moodCode | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "EVN" | |
| Item | code@code | |
| HL7v3 | pertinentCREType\code@code | |
| FHIR | no mapping | |
| Notes | HL7v3: A code from the CRE SNOMED hierarchy(<162931000000103). The values for COVID-19 will be one of: 163001000000103 | Diagnoses 163131000000108 | Clinical observations and findings 163141000000104 | Investigation results Note: the COVID code(s) sent must appear in the relevant CMET - see below. This will indicate the FHIR resource type to be used. |
|
| Item | code@codeSystem | |
| HL7v3 | pertinentCREType\code@codeSystem | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "2.16.840.1.113883.2.1.3.2.4.15" | |
| Item | code@displayName | |
| HL7v3 | pertinentCREType\code@displayName | |
| FHIR | no mapping | |
| Notes | HL7v3: The display of the selected code |
<pertinentCREType classCode="CATEGORY" moodCode="EVN"> <code code="163001000000103" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Diagnoses"/>
Note: the component repeats for each instance of a given CREType
| Mapping | ||
|---|---|---|
| Item | @typeCode | |
| HL7v3 | component@typeCode | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "COMP" | |
| Item | @contextConductionInd | |
| HL7v3 | component@contextConductionInd | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "true" | |
| Item | templateId@root | |
| HL7v3 | component@templateId@root | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "2.16.840.1.113883.2.1.3.2.4.18.2" | |
| Item | templateId@extension | |
| HL7v3 | component\templateId@extension | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "CSAB_RM-NPfITUK10.component" | |
| Item | seperatableInd@value | |
| HL7v3 | component\seperatableInd@value | |
| FHIR | no mapping | |
| Notes | HL7v3: Fixed to "false" |
<component typeCode="COMP" contextConductionInd="true"> <templateId root="2.16.840.1.113883.2.1.3.2.4.18.2" extension="CSAB_RM-NPfITUK10.component"/> <seperatableInd value="false"/>
<pertinentInformation2 typeCode="PERT" inversionInd="false" contextConductionInd="true" negationInd="false"> <templateId root="2.16.840.1.113883.2.1.3.2.4.18.2" extension="CSAB_RM-NPfITUK10.pertinentInformation1"/> <seperatableInd value="true"/> <pertinentCREType classCode="CATEGORY" moodCode="EVN"> <code code="163001000000103" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Diagnoses"/> <component typeCode="COMP" contextConductionInd="true"> <templateId root="2.16.840.1.113883.2.1.3.2.4.18.2" extension="CSAB_RM-NPfITUK10.component"/> <seperatableInd value="false"/>
The appropriate CMET (SCR Section) is then chosen to carry the data.
- For Diagnoses use A_Diagnosis (UKCT_RM144042UK01)
- For Investigation Results OR Clinical Observations and Findings use A_Finding (UKCT_RM144043UK02)
Both of these CMETs share the same author classes. The author classes are documented once.
For the Diagnoses Coded Entries see Mapping Diagnoses
For the Investigation Results and Clinical Observations and Findings see Mapping Finding
For the generic participations see Mapping Participants
The Diagnosis Coded Entry covers 4 out of the 5 COVID-19 codes
| Concept | Preferred term | SCR Section |
|---|---|---|
| 1240751000000100 | COVID-19 | Diagnoses |
| 1300721000000109 | COVID-19 confirmed by laboratory test | Diagnoses |
| 1300731000000106 | COVID-19 confirmed using clinical diagnostic criteria | Diagnoses |
| 1240761000000102 | Suspected COVID-19 | Diagnoses |
The Diagnoses HL7v3 CMET will map to a FHIR Condition resource.
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT144042UK01.Diagnosis@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "OBS" FHIR: this has no mapping in FHIR |
| Item | @moodCode |
| HL7v3 | UKCT_MT144042UK01.Diagnosis@moodCode |
| FHIR | no mapping |
| Notes | Hl7v3: fixed to "EVN" FHIR: this has no mapping in FHIR |
| Item | id@root |
| HL7v3 | UKCT_MT144042UK01.Diagnosis.id@root |
| FHIR | Condition\identifier\value@value |
| Notes | a UUID that acts as the identifier for the coded entry |
| Item | code@code |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\code@code |
| FHIR | Condition\code\coding\code@value |
| Notes | This will be one of the 4 COVID-19 diagnoses codes 1240751000000100|COVID-19 1300721000000109|COVID-19 confirmed by laboratory test 1300731000000106|COVID-19 confirmed using clinical diagnostic criteria 1240761000000102|Suspected COVID-19 |
| Item | code@codeSystem |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\code@codeSystem |
| FHIR | Condition\code\coding\system@value |
| Notes | HL7v3: fixed to "2.16.840.1.113883.2.1.3.2.4.15" FHIR: fixed to "http://snomed.info/sct" |
| Item | code@displayName |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\code\displayName |
| FHIR | Condition\code\coding\display@value |
| Notes | The display associated with the selected codes (as above in the Notes fro code@code |
| Item | statusCode.code@value |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\statusCode\code@value |
| FHIR | Condition\verificationStatus\code@value Condition\clinicalStatus\code@value |
| Notes | FHIR: normal->clinicalStatus.active nullified->verificationStatus.entered-in-error active->clinicalStatus.active completed->verificationStatus.confirmed Note: round-tipping from normal & active is not possible. This may be a clinical risk. |
| Item | effectiveTime@value |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\effectiveTime\low@value UKCT_RM144042UK01.Diagnosis\effectiveTime\high@value |
| FHIR | Condition\onsetDateTime\value@value and Condition\abatementDateTime\value@value |
| Notes | HL7v3: Where known the dates that the diagnosis was affective on the patient should be used i.e when the patient started with asthma and when the asthma was no longer present for the patient. The date range shall be carried as follows: If both a start date and an end date are present the Date or Time Interval Complete data type 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 data type shall be used: The low attribute shall contain the start date. FHIR: map low to onsetDateTime, map high to abatementDateTime |
| Item | value |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\value |
| FHIR | Observation\value[x] |
| Notes | defined as being "The value of the observation." FHIR: this should be modelled as a supporting Observation. Link an Observation from Condition\evidence\detail to an Observation resource. The Observation resource has the follwoubg element that are mandated: Observation\status - fix to either "unknown" if the status is unknown - or an appropriate status Observation\code - use the same code as used in Condition\code choose the appropriate value[x] data type to hiold the value of the Observation |
| Item | value |
| HL7v3 | UKCT_MT144042UK01.Diagnosis\value\pertinentInformation\pertinentSupportingInfo\value |
| FHIR | Condition\note |
| Notes | Supporting text for the Diagnosis |
<UKCT_MT144042UK01.Diagnosis classCode="OBS" moodCode="EVN"> <id root="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> <code code="1300721000000109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="COVID-19 confirmed by laboratory test"> </code> <statusCode code="normal"/> <effectiveTime> <low value="20200506104819"/> </effectiveTime> <pertinentInformation typeCode="PERT" contextConductionInd="true"> <seperatableInd value="false"/> <pertinentSupportingInfo classCode="OBS" moodCode="EVN"> <value>Problem; First, test</value> <code code="SupportingText" CodeSystem="2.16.840.1.113883.2.1.3.2.4.17.126" displayName="Supporting Text"/> </pertinentSupportingInfo> </pertinentInformation> </UKCT_MT144042UK01.Diagnosis>
<Condition xmlns="http://hl7.org/fhir"> <meta> <profile value="https://fhir.nhs.uk/StructureDefinition/UKCore-Condition" /> </meta> <identifier> <value value="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> </identifier> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <code> <coding> <system value="http://snomed.info/sct" /> <code value="1300721000000109" /> <display value="COVID-19 confirmed by laboratory test"/> </coding> </code> <onsetDateTime value="2020-05-06T10:48:19+00:00"/> <note> <text value="Problem; First, test"/> </note> </Condition>
The relevant paticipants for Diagnosis are author and informant. For details on how to populate participants see the Mapping Participants page.
PertinentInformation
Note: This is a link class to supporting information. In terms of FHIR mapping, all the values here are fixed HL7v3 values, except the SupportingInfo.text, which maps to Condition.note
| Mapping | |
|---|---|
| Item | @typeCode |
| HL7v3 | pertinentInformation@typeCode |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "PERT" FHIR:no mapping |
| Item | @contextControlCode |
| HL7v3 | pertinentInformation@contextControlCode |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "true" FHIR:no mapping |
| Item | seperatableInd@value |
| HL7v3 | pertinentInformation.seperatableInd@value |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "false" FHIR:no mapping |
SupportingInformation
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | SupportingInformation@classCode |
| FHIR | no mapping |
| Notes | HL7v3: fixed to "OBS" |
| Item | @moodCode |
| HL7v3 | SupportingInformation@moodCode |
| FHIR | no mapping |
| Notes | HL7v3: fixed to "EVN" |
| Item | code@code |
| HL7v3 | SupportingInformation.code@code |
| FHIR | no mapping |
| Notes | HL7v3: fixed to "SupportingText" |
| Item | code@codeSystem |
| HL7v3 | SupportingInformation.code@coseSystem |
| FHIR | no mapping |
| Notes | HL7bv3: fixed to "2.16.840.1.113883.2.1.3.2.4.17.126" |
| Item | code@displayName |
| HL7v3 | SupportingInformation.code@displayName |
| FHIR | no mapping |
| Notes | HL7v3: fixed to "Supporting Text" |
| Item | value |
| HL7v3 | SupportingInformation.value |
| FHIR | Condition.note.text |
| Notes |
<UKCT_MT144042UK01.Diagnosis classCode="OBS" moodCode="EVN"> <id root="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> <code code="1300721000000109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="COVID-19 confirmed by laboratory test"> </code> <statusCode code="normal"/> <effectiveTime> <low value="20200506104819"/> </effectiveTime> <pertinentInformation typeCode="PERT" contextConductionInd="true"> <seperatableInd value="false"/> <pertinentSupportingInfo classCode="OBS" moodCode="EVN"> <value>Some Supporting Information</value> <code code="SupportingText" displayName="Supporting Text" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.126"></code> </pertinentSupportingInfo> </pertinentInformation> </UKCT_MT144042UK01.Diagnosis>
<Condition xmlns="http://hl7.org/fhir"> <meta> <profile value="https://fhir.nhs.uk/StructureDefinition/UKCore-Condition" /> </meta> <identifier> <value value="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> </identifier> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <code> <coding> <system value="http://snomed.info/sct" /> <code value="1300721000000109" /> <display value="COVID-19 confirmed by laboratory test"/> </coding> </code> <onsetDateTime value="2020-05-06T10:48:19+00:00"/> <note> <text value="Some Supporting Information"/> </note> </Condition>
PertinentInformation1
Note: this is a link class to other information that may be referenced in the composition (or bundle).
All of the values here are HL7v3 fixed codes, and have no mapping to FHIR. The only FHIR mapping is from pertinentFinding\id, which maps to Condition\evidence\detail
| Mapping | |
|---|---|
| Item | @typeCode |
| HL7v3 | @typeCode |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "PERT" FHIR: no mapping |
| Item | @inversionInd |
| HL7v3 | @inversionInd |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "false" FHIR: no mapping |
| Item | negationInd |
| HL7v3 | pertinentInformation1@negationInd |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "false" FHIR: no mapping |
| Item | seperatableInd@value |
| HL7v3 | pertinentInformation1.seperatableInd@value |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "false" FHIR: no mapping |
| Item | templateId\root@value |
| HL7v3 | pertinentInformation1\root@value |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "2.16.840.1.113883.2.1.3.2.4.18.2" FHIR: no mapping |
| Item | templateId\extension@value |
| HL7v3 | pertinentInformation1\extension@value |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "CSAB_RM-NPfITUK10.sourceOf1" FHIR: no mapping |
Finding
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | Finding@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "OBS" FHIR: no mapping |
| Item | @moodCode |
| HL7v3 | Finding@moodCode |
| FHIR | no mapping |
| Notes | Hl7v3: fixed to "EVN" FHIR: no mapping |
| Item | id@root |
| HL7v3 | Finding@root |
| FHIR | Condition\evidence\detail |
| Notes | FHIR: use the evidence\detail reference to link to any relevant Findings in the bundle |
<UKCT_MT144042UK01.Diagnosis classCode="OBS" moodCode="EVN"> <id root="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> <code code="1300721000000109" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="COVID-19 confirmed by laboratory test"> </code> <statusCode code="normal"/> <effectiveTime> <low value="20200506104819"/> </effectiveTime> <pertinentInformation1 typeCode="PERT" inversionInd="false" negationInd="false"> <templateId root="2.16.840.1.113883.2.1.3.2.4.18.2" extension="CSAB_RM-NPfITUK10.sourceOf1"/> <seperatableInd value="false"/> <pertinentFinding classCode="OBS" moodCode="EVN"> <id root="50E3A850-8F89-11EA-BE46-00155DC3FA77"></id> </pertinentFinding> </pertinentInformation1> </UKCT_MT144042UK01.Diagnosis>
<Condition xmlns="http://hl7.org/fhir"> <meta> <profile value="https://fhir.nhs.uk/StructureDefinition/UKCore-Condition" /> </meta> <identifier> <value value="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> </identifier> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-clinical" /> <code value="active" /> <display value="Active" /> </coding> </clinicalStatus> <code> <coding> <system value="http://snomed.info/sct" /> <code value="1300721000000109" /> <display value="COVID-19 confirmed by laboratory test"/> </coding> </code> <onsetDateTime value="2020-05-06T10:48:19+00:00"/> <evidence> <detail> <reference value="50E3A850-8F89-11EA-BE46-00155DC3FA77"/> </detail> </evidence> </Condition>
The Finding CMET covers 1240581000000104 | SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive.
The Finding CMET covers Observations for Blood Pressure, Weight, Height, Temerature, FindingOrganizer as well a general Finding class. As the COVID entry will only appear under the general Finding class, its is just this that class that is documented here.
The Finding class has an option to apply a ReferenceValue (a reference range). As the COVID entry is a statement, the reference range is not relevant, so is not documented here.
Finding is mapped to the FHIR Observation resource
Finding
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT144043UK02.Finding@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "OBS" FHIR: no mapping |
| Item | @moodCode |
| HL7v3 | UKCT_MT144043UK02.Finding@moodCode |
| FHIR | no mapping |
| Notes | Hl7v3: Fixed to "EVN" FHIR: no mapping |
| Item | id@root |
| HL7v3 | UKCT_MT144043UK02.Finding.id@root |
| FHIR | Observation\identifier\value@value |
| Notes | HL7v3: a UUID |
| Item | code@code |
| HL7v3 | UKCT_MT144043UK01.Finding\code@code |
| FHIR | Observation\code\coding\code@value |
| Notes | The only use case documented to to carry 1240581000000104 | SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive |
| Item | code@codeSystem |
| HL7v3 | UKCT_MT144043UK02.Finding\code@codeSystem |
| FHIR | Observation\code\coding\system@value |
| Notes | HL7v3: fixed to "2.16.840.1.113883.2.1.3.2.4.15" FHIR: fixed to "http://snomed.info/sct" |
| Item | code@displayName |
| HL7v3 | UKCT_MT144043UK02.Finding\code\displayName |
| FHIR | Observation\code\coding\display@value |
| Notes | see item code@code above |
| Item | statusCode.code@value |
| HL7v3 | UKCT_MT144043UK02.Finding.statusCode.code@value |
| FHIR | Observation\status\code@value |
| Notes | FHIR normal->final nullified->entered-in-error active->final completed->final Note that this cannot be round-tripped & may be clinically unsafe |
| Item | effectiveTime@value |
| HL7v3 | UKCT_MT144043UK02.Finding.effectiveTime@value |
| FHIR | Observation\effective[x] - see Notes |
| Notes | Hl7v3: 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. The center attribute may be used if the exact start / end time is not known The center attribute shall contain a time stamp. FHIR:When mapping low or high, use effectivePeriod (low=start; high=end), when mapping centre then map to effectiveDateTime@value |
| Item | value |
| HL7v3 | UKCT_MT144043UK02.Finding.value |
| FHIR | Observation\status\value[x] |
| Notes | FHIR:this is information in support of the coded value, using an appropriate data type from value[x] |
<UKCT_MT144043UK02.Finding classCode="OBS" moodCode="EVN"> <id root="0F582D92-8F89-11EA-8B2D-B741F13EFC47"/> <code code="1240581000000104" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"> </code> <statusCode code="completed"/> <effectiveTime> <low value="20200506104819"/> </effectiveTime> </UKCT_MT144043UK02.Finding>
<Observation> <meta> <profile value="https://fhir.nhs.uk/StructureDefinition/UKCore-Observation" /> </meta> <identifier> <value value="0F582D92-8F89-11EA-8B2D-B741F13EFC47"/> </identifier> <status value="final"/> <code> <coding> <code value="1240581000000104"/> <display value="SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"/> <system value="http://snomed.info/sct"/> </coding> </code> <effectivePeriod> <start value="2020-05-06T10:48:19+00:00"/> </effectivePeriod> </Observation>
<Observation> <meta> <profile value="https://fhir.nhs.uk/StructureDefinition/UKCore-Observation" /> </meta> <identifier> <value value="0F582D92-8F89-11EA-8B2D-B741F13EFC47"/> </identifier> <status value="final"/> <code> <coding> <code value="1240581000000104"/> <display value="SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) RNA (ribonucleic acid) detection result positive"/> <system value="http://snomed.info/sct"/> </coding> </code> <effectiveDateTime value="2020-05-06T10:48:19+00:00"/> </Observation>
**The relevant paticipants for Finding are author, informant and performer. For details on how to populate participants link classes see the ParticipantCodedEntry page. For the Role details see
The participant types allowed for Diagnoses are
The participant types allowed for Finding are
For Diagnoses & Finding authors are described using the HL7v3 CMET R_AgentNPFITPersonGeneral (UKCT_RM160018UK01). Findings also allow authors to be described as a device R_AgentNPFITDevice (UKCT_RM120600UK02).
Informants are described for both Diagnoses & Fings as being a R_AgentNPFITPersonGeneral (UKCT_RM160018UK01), or a NonAgentRole.
Performers are described as being R_AgentNPFITPersonGeneral (UKCT_RM160018UK01).
Note: FHIR resources carry a limited number of participation types. In particular, FHIR resources often lack the dates of participantion - for example the Condition resource allows you to record the asserter (informant), but not the date of assertion. In order to give a consistent approach to participations, the Encounter resource is used, in particular the participant backbone element to link to relevant participants.
author
| Mapping | |
|---|---|
| Item | @typeCode |
| HL7v3 | author@typeCode |
| FHIR | Encounter\participant\type\coding\code@value |
| Notes | HL7v3:fixed to "AUT" FHIR: code@value="AUT" system@value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" display.value="author" |
| Item | @contextControlCode |
| HL7v3 | author@contextControlCode |
| FHIR | no mapping |
| Notes | HL7v3:fixed to "OP" |
| Item | time@value |
| HL7v3 | author.time@value |
| FHIR | Encounter.participant.period.start@value |
| Notes |
<author typeCode="AUT" contextControlCode="OP"> <time value="20200506104819"/> <!--roles go here--> </author>
<Encounter> <!--Encounter must have values for status & class - so fix as shown--> <status value="finished"/> <class> <code value="UNK"/> <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor"/> <display value="Unknown"/> </class> <participant> <type> <coding> <code value="AUT"/> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> <display value="author"/> </coding> </type> <period> <start value="2020-05-06T10:48:19+00:00"/> </period> <individual> <!--A link to the participation--> <reference value="cb9694ea-36f1-4e33-87cc-361409d251c6"/> </individual> </participant> </Encounter>
performer
| Mapping | |
|---|---|
| Item | @typeCode |
| HL7v3 | performer@typeCode |
| FHIR | Encounter\participant\type\coding\code@value |
| Notes | HL7v3: fixed to "PRF" FHIR: code@value="PRF" system@value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" display.value="performer" |
| Item | @contextControlCode |
| HL7v3 | performer@contextControlCode |
| FHIR | no mapping |
| Notes | HL7v3: fixed to "OP" |
| Item | time@value |
| HL7v3 | performer.time@value |
| FHIR | Encounter.participant.period.start@value |
| Notes | |
| Item | modeCode.code@code |
| HL7v3 | performer.modeCode.code@code |
| FHIR | Encounter.participant.[extensionModeCode] - see below |
| Notes |
Example of the modeCode extension
<extension url="https://fhir.nhs.uk/StructureDefinition/Extension-SCR-ModeCode"> <valueCodeableConcept> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationMode" /> <code value="PHYSICAL" /> <display value="physical presence" /> </coding> </valueCodeableConcept> </extension>
modeCode in an Encounter example
<Encounter> <!--Encounter must have values for status & class - so fix as shown--> <status value="finished"/> <class> <code value="UNK"/> <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor"/> <display value="Unknown"/> </class> <participant> <extension url="https://fhir.nhs.uk/StructureDefinition/Extension-SCR-ModeCode"> <valueCodeableConcept> <coding> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationMode" /> <code value="PHYSICAL" /> <display value="physical presence" /> </coding> </valueCodeableConcept> </extension> <type> <coding> <code value="PRF"/> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> <display value="performer"/> </coding> </type> <period> <start value="2020-05-06T10:48:19+00:00"/> </period> <individual> <!--A link to the participation--> <reference value="cb9694ea-36f1-4e33-87cc-361409d251c6"/> </individual> </participant> </Encounter>
HL7v3 Performer Example (with modeCode)
<performer typeCode="PRF" contextControlCode="OP"> <time value="20160630103358"/> <modeCode code="PHYSICAL" codeSystem="2.16.840.1.113883.5.1064"/> <UKCT_MT160018UK01.AgentPersonSDS classCode="AGNT"> <id root="1.2.826.0.1285.0.2.0.67" extension="173067658018"></id> <agentPersonSDS classCode="PSN" determinerCode="INSTANCE"> <id root="1.2.826.0.1285.0.2.0.65" extension="784578436584"></id> <name>JONES Bob</name> </agentPersonSDS> </UKCT_MT160018UK01.AgentPersonSDS> </performer>
Maps to FHIR Encounter.participant
<participant>
<extension url="https://fhir.nhs.uk/StructureDefinition/Extension-SCR-ModeCode">
<valueCodeableConcept>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationMode" />
<code value="PHYSICAL" />
<display value="physical presence" />
</coding>
</valueCodeableConcept>
</extension>
<type>
<coding>
<code value="PRF"/>
<system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/>
<display value="performer"/>
</coding>
</type>
<individual>
<!--A link to the participation where you find the name, SDS id, Job Role code etc.-->
<reference value="cb9694ea-36f1-4e33-87cc-361409d251c6"/>
</individual>
</participant>
Informant
| Mapping | |
|---|---|
| Item | @typeCode |
| HL7v3 | informant@typeCode |
| FHIR | Encounter\participant\type\coding\code@value |
| Notes | HL7v3: fixed to "INF" FHIR: code@value="INF" system@value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType" display.value="informant" |
| Item | @contextControlCode |
| HL7v3 | informant@contextControlCode |
| FHIR | no mapping |
| Notes | HL7v3: fixed to "OP" |
| Item | time@value |
| HL7v3 | informant.time@value |
| FHIR | Encounter.participant.period.start@value |
| Notes |
Hl7v3 Example
<informant typeCode="INF" contextControlCode="OP"> <time value="20160630103358"/> <UKCT_MT160018UK01.AgentPersonSDS classCode="AGNT"> <id root="1.2.826.0.1285.0.2.0.67" extension="173067658018"></id> <agentPersonSDS classCode="PSN" determinerCode="INSTANCE"> <id root="1.2.826.0.1285.0.2.0.65" extension="784578436584"></id> <name>JONES Bob</name> </agentPersonSDS> </UKCT_MT160018UK01.AgentPersonSDS> </informant>
<Encounter> <!--Encounter must have values for status & class - so fix as shown--> <status value="finished"/> <class> <code value="UNK"/> <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor"/> <display value="Unknown"/> </class> <participant> <type> <coding> <code value="INF"/> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> <display value="informant"/> </coding> </type> <period> <start value="2020-05-06T10:48:19+00:00"/> </period> <individual> <!--A link to the participation--> <reference value="cb9694ea-36f1-4e33-87cc-361409d251c7"/> </individual> </participant> </Encounter>
FHIR example showing bundle links to Encounter
<Bundle xmlns="http://hl7.org/fhir"> <id value="UKCore-Bundle-BundledAllergyList-Example"/> <type value="collection"/> <entry> <resource> <Composition> <!--Composition header bits go here--> <section> <title value="Diagnoses"/> <text> <!--section text goes here--> </text> <entry> <!--link to the coded data fro Diagnoses--> <reference value="urn:uuid:e5fc3307-eac7-4665-99f7-dc6ac9f72910"/> </entry> </section> <!--Rest of composition goes here--> </Composition> </resource> </entry> <!--A diagnosis--> <entry> <fullUrl value="urn:uuid:e5fc3307-eac7-4665-99f7-dc6ac9f72910"/> <resource> <Condition> <id value="e5fc3307-eac7-4665-99f7-dc6ac9f72910"/> <meta> <profile value="https://fhir.nhs.uk/StructureDefinition/UKCore-Condition"/> </meta> <identifier value="0F582D97-8F89-11EA-8B2D-B741F13EFC47"/> <clinicalStatus> <coding> <system value="http://terminology.hl7.org/CodeSystem/condition-clinical"/> <code value="active"/> <display value="Active"/> </coding> </clinicalStatus> <code> <coding> <system value="http://snomed.info/sct"/> <code value="1300721000000109"/> <display value="COVID-19 confirmed by laboratory test"/> </coding> </code> <!--link to the encounter to link in participants--> <encounter> <reference value="urn:uuid:a0205cd2-e56d-4c3b-92c0-d1c0a7b389cb"/> </encounter> <onsetDateTime value="2020-05-06T10:48:19+00:00"/> </Condition> </resource> </entry> <!--the Encounter containing the participant links--> <entry> <fullUrl value="urn:uuid:e5fc3307-eac7-4665-99f7-dc6ac9f72910"/> <resource> <Encounter> <status value="finished"/> <class> <code value="UNK"/> <system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor"/> <display value="Unknown"/> </class> <!--an Author--> <participant> <type> <coding> <code value="AUT"/> <system value="http://terminology.hl7.org/CodeSystem/v3-ParticipationType"/> <display value="author"/> </coding> </type> <period> <start value="2020-05-06T10:48:19+00:00"/> </period> <individual> <!--A link to the participation--> <reference value="urn:uuid:cb9694ea-36f1-4e33-87cc-361409d251c6"/> </individual> </participant> </Encounter> </resource> </entry> <!--the paractitioner playing the author--> <entry> <fullUrl value="urn:uuid:cb9694ea-36f1-4e33-87cc-361409d251c6"/> <resource> <PractitionerRole> <id value="83c26c8f-ee72-4534-8891-0136972b2106"/> <identifier> <system value="http://fhir.nhs.net/Id/sds-role-profile-id"/> <value value="123456"/> </identifier> <practitioner> <reference value="urn:uuid:b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> </practitioner> </PractitionerRole> </resource> </entry> <entry> <fullUrl value="urn:uuid:b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> <resource> <Practitioner> <id value="b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id"/> <value value="RT555"/> </identifier> <name> <family value="BLOGGS"/> <given value="Fred"/> </name> </Practitioner> </resource> </entry> </Bundle>
This page shows the commonly used author role class NonAgentRole mapping to FHIR.
This page will be referenced from the appropriate CRETypes pages.
NonAgent
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | NonAgentRole@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "ROL" |
| Item | id@root |
| HL7v3 | NonAgentRole.id@root |
| FHIR | RelatedPerson\identifier\system@value |
| Notes | HL7v3: Fixed to "2.16.840.1.113883.2.1.4.1" FHIR: Fixed to "https://fhir.nhs.uk/Id/nhs-number" |
| Item | id@extension |
| HL7v3 | NonAgentRole.id@extension |
| FHIR | RelatedPerson\identifier\value@value |
| Notes | NHS Number |
| Item | code@code |
| HL7v3 | NonAgentRole.code@code |
| FHIR | RelatedPerson\relationship\coding\code@value |
| Notes | |
| Item | code@codeSystem |
| HL7v3 | NonAgentRole.code@codeSystem |
| FHIR | RelatedPerson\relationship\coding\system@value |
| Notes | HL7v3: Fixed to "2.16.840.1.113883.2.1.3.2.4.16.15" FHIR: Fixed to "https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1" |
| Item | code@displayName |
| HL7v3 | NonAgentRole.code@displayName |
| FHIR | RelatedPerson\relationship\coding\display@value |
| Notes |
Note if a nonAgentPerson is linked from from the nonAgentRole, then in FHIR terms, use the Person\link\target to link this RelatedPerson to Person resource.
NonAgentPerson
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | NonAgenPerson@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "PSN" |
| Item | @determinerCode |
| HL7v3 | NonAgenPerson@determinerCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | name |
| HL7v3 | NonAgenPerson.name |
| FHIR | RelatedPerson.name |
| Notes |
HL7v3 example of NonAgentRole in a Finding
<UKCT_MT144043UK02.Finding classCode="OBS" moodCode="EVN"> <id root="D745F1E0-6DF2-11EA-AE26-C5CB3F0B33D1"/> <code code="397686008" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Sense of smell, function"> <originalText>Sense of smell</originalText> </code> <statusCode code="completed"/> <effectiveTime> <low value="20200324171258"/> </effectiveTime> <informant typeCode="INF" contextControlCode="OP"> <time value="20160630103358"/> <participantNonAgentRole classCode="ROL"> <code code="01" displayName="Brother" codeSystem="2.16.840.1.113883.2.1.3.2.4.16.15"></code> <playingNonAgentPerson classCode="PSN" determinerCode="INSTANCE"> <name>JONES Bob</name> </playingNonAgentPerson> </participantNonAgentRole> </informant> </UKCT_MT144043UK02.Finding>
HL7v3
<participantNonAgentRole classCode="ROL"> <code code="15" displayName="Brother" codeSystem="2.16.840.1.113883.2.1.3.2.4.16.15"></code> <playingNonAgentPerson classCode="PSN" determinerCode="INSTANCE"> <name>BLOGGS Bill</name> </playingNonAgentPerson> </participantNonAgentRole>
FHIR
<RelatedPerson> <patient> <reference value="f97eff4a-162c-4336-992e-ef669e8c0481"/> </patient> <relationship> <coding> <code value="15"/> <system value="https://fhir.nhs.uk/STU3/ValueSet/PersonRelationshipType-1"/> <display value="Brother"/> </coding> <relationship> <name> <family value="BLOGGS"/> <given value="Bill"/> </name> </RelatedPerson>
This page shows the commonly used author role CMET R_AgentNPFITDevice (UKCT_RM120600UK02).
This role is optionally used to describe a Finding author.
AgentDevice
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | AgentDevice@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "AGNT" |
| Item | id@root |
| HL7v3 | AgentDevice.id@root |
| FHIR | Device\identifier\value@value |
| Notes | |
| Item | code@coode |
| HL7v3 | AgentDevice.code@code |
| FHIR | |
| Notes | Can't find a mapping |
| Item | code@codeSystem |
| HL7v3 | AgentDevice.code@codeSystem |
| FHIR | |
| Notes | Can't find a mapping |
| Item | code@displayName |
| HL7v3 | AgentDevice.code@displayName |
| FHIR | |
| Notes | Can't find a mapping |
OrganizationSDS
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | OrganizationSDS@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "ORG" |
| Item | @determinerCode |
| HL7v3 | OrganizationSDS.determinerCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | id@root |
| HL7v3 | OrganizationSDS.id@root |
| FHIR | organization/identifier/system@value |
| Notes | HL7v3: Fixed to "1.2.826.0.1285.0.1.10" (for org) "1.2.826.0.1285.0.2.0.109" (for workgroup) |
| FHIR: Fixed to "https://fhir.nhs.uk/Id/ods-organization-code" | |
| Item | id@extension |
| HL7v3 | OrganizationSDS.id@extension |
| FHIR | organization/identifier/value/@value |
| Notes |
Oganization
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | Organization@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "ORG" |
| Item | @determinerCode |
| HL7v3 | Organization.determinerCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | id@root |
| HL7v3 | Organization.id@root |
| FHIR | Organization/id/@root |
| Notes | HL7v3: Fixed to "1.2.826.0.1285.0.1.10" |
| FHIR: Fixed to "https://fhir.nhs.uk/Id/ods-organization-code" | |
| Item | id@extension |
| HL7v3 | Organization.id@extension |
| FHIR | organization/identifier/value/@value |
| Notes | |
| Item | code@code |
| HL7v3 | Organization.code@code |
| FHIR | organization\type\code@value |
| Notes | |
| Item | name |
| HL7v3 | Organization.name |
| FHIR | organization\name |
| Notes | |
| Item | desc |
| HL7v3 | Organization.desc |
| FHIR | no mapping |
| Notes | |
| Item | telecom |
| HL7v3 | Organization.telecom |
| FHIR | organization\telecom |
| Notes | |
| Item | addr |
| HL7v3 | Organization.addr |
| FHIR | organization\addr |
| Notes |
DeviceSDS
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | DeviceSDS@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "DEV" |
| Item | @determinerCode |
| HL7v3 | DeviceSDS@determinerCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | id@root |
| HL7v3 | DeviceSDS.id@root |
| FHIR | Device.identifier |
| Notes | HL7v3: Fixed to "1.2.826.0.1285.0.2.0.107" |
| FHIR: (system fix to https://fhir.nhs.uk/Id/SDSDevice) | |
| Item | id@extension |
| HL7v3 | DeviceSDS.id@extension |
| FHIR | device/identifier/value/@value |
| Notes |
Device
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | Device@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "DEV" |
| Item | @determinerCode |
| HL7v3 | Device@determinerCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | id@root |
| HL7v3 | Device.id@root |
| FHIR | |
| Notes | FHIR: no system exist for devices - so leave out |
| Item | id@extension |
| HL7v3 | Device.id@extension |
| FHIR | device\identifier\value@value |
| Notes | |
| Item | code |
| HL7v3 | Device.code@code |
| FHIR | device\type\coding\code |
| Notes | FJIR: Just copy over the code & display - leave out system |
| Item | name |
| HL7v3 | Device.name |
| FHIR | device.deviceName.name |
| Notes | FHIR: set the device.deviceName.type to "other" |
| Item | desc |
| HL7v3 | Device.desc |
| FHIR | device\note |
| Notes | |
| Item | manufacturerModelName |
| HL7v3 | Device.manufacturerModelName |
| FHIR | device.deviceName.name |
| Notes | FHIR: set the device.deviceName.type to "manufacturer-name" |
| Item | softwareName |
| HL7v3 | Device.softwareName |
| FHIR | device\version\value@value |
| Notes |
HL7v3 Device in context of a finding
<UKCT_MT144043UK02.Finding classCode="OBS" moodCode="EVN"> <id root="D745F1E0-6DF2-11EA-AE26-C5CB3F0B33D1"/> <code code="397686008" codeSystem="2.16.840.1.113883.2.1.3.2.4.15" displayName="Sense of smell, function"> <originalText>Sense of smell</originalText> </code> <statusCode code="completed"/> <effectiveTime> <low value="20200324171258"/> </effectiveTime> <author typeCode="AUT" contextControlCode="OP"> <time value="20160630103358"/> <UKCT_MT120601UK02.AgentDevice classCode="AGNT"> <id root="AAA5F1E0-6DF2-11EA-AE26-C5CB3F0B33D1"/> <agentDeviceSDS classCode="DEV" determinerCode="INSTANCE"> <id root="1.2.826.0.1285.0.2.0.107" extension="7867868687687"/> </agentDeviceSDS> <representedOrganizationSDS classCode="ORG" determinerCode="INSTANCE"> <id root="ABC123" extension="1.2.826.0.1285.0.1.10"></id> </representedOrganizationSDS> </UKCT_MT120601UK02.AgentDevice> </author> </UKCT_MT144043UK02.Finding>
FHIR example
<Device> <identifier> <value value="AAA5F1E0-6DF2-11EA-AE26-C5CB3F0B33D1"/> </identifier> <identifier> <system value="https://fhir.nhs.uk/Id/SDSDevice"/> <value value="7867868687687"/> </identifier> <!-- a link to the owning SDS Organisation --> <owner> <reference value="urn:uuid:abc5dd89-fc3a-466d-baad-126c0aac46fc"/> </owner> </Device>
This page shows the commonly used CMET R_AgentNPFITPersonGeneral (UKCT_RM160018UK01) mapping to FHIR.
This page will be referenced from the appropriate CRETypes pages.
When using the AgentNPFITPersonGeneral CMET, there is a choice of author format
Agennt Person SDS (and Person SDS) are fulfilled in FHIR by the use of PractitionerRole & Practitioner
AgentPersonSDS
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "AGNT" FHIR: no mapping |
| Item | id@root |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/id/@root |
| FHIR | PractitionerRole/identifier/system/@value |
| Notes | HL7v3: Fixed to 1.2.826.0.1285.0.2.0.67 FHIR: Fixed to "http://fhir.nhs.net/Id/sds-role-profile-id" |
| Item | id@extension |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/id/@extension |
| FHIR | PractitionerRole/identifier/value/@value |
| Notes | The SDSRole ProfileID |
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPersonSDS/@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | @determinerCode |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPersonSDS/@determinerCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "INSTANCE" |
| Item | id@root |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPersonSDS/id/@root |
| FHIR | Practitioner/identifier/system/@value |
| Notes | HL7v3: Fixed to ".2.826.0.1285.0.2.0.65" FHIR: Fixed to "https://fhir.nhs.uk/Id/sds-user-id" |
| Item | id@extension |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPersonSDS/id/@extension |
| FHIR | Practitioner/identifier/value/@value |
| Notes | The SDSUserID |
| Item | name |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPersonSDS/name |
| FHIR | Practitioner/name |
| Notes | Name of the author |
HL7v3
<UKCT_MT160018UK01.AgentPersonSDS classCode="AGNT"> <id root="1.2.826.0.1285.0.2.0.67" extension="123456"></id> <agentPersonSDS classCode="PSN" determinerCode="INSTANCE"> <id root="1.2.826.0.1285.0.2.0.65" extension="RT555"></id> <name>BLOGGS Fred</name> </agentPersonSDS> </UKCT_MT160018UK01.AgentPersonSDS>
FHIR
<PractitionerRole> <id value="83c26c8f-ee72-4534-8891-0136972b2106"/> <identifier> <system value="http://fhir.nhs.net/Id/sds-role-profile-id"/> <value value="123456"/> </identifier> <practitioner> <reference value="urn:uuid:b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> </practitioner> </PractitionerRole> <Practitioner> <id value="b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> <identifier> <system value="https://fhir.nhs.uk/Id/sds-user-id"/> <value value="RT555"/> </identifier> <name> <family value="BLOGGS"/> <given value="Fred"/> </name> </Practitioner>
AgentPerson
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/@classCode |
| FHIR | no mapping |
| Notes | HL7v3: Fixed to "AGNT" |
| Item | code@code |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/code/@code |
| FHIR | PractitionerRole/code/coding/code/@value |
| Notes | A jobRole code |
| Item | code@codeSystem |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/code/@codeSystem |
| FHIR | PractitionerRole/code/coding/system/@value |
| Notes | HL7v3: Fixed to "2.16.840.1.113883.2.1.3.2.4.17.124" FHIR: Fixed to"https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName" |
| Item | code@displayName |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/code/@displayName |
| FHIR | PractitionerRole/code/coding/dispaly/@value |
| Notes | Display of the code |
| Item | addr |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/addr |
| FHIR | organization/address |
| Notes | Address of the organisation |
| Item | telecom |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/telecom |
| FHIR | organization/telecom |
| Notes | Organisation telecom |
Organization (if using this option)
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganization/@classCode |
| FHIR | no mapping |
| Notes | Fixed to "ORG" |
| Item | @determinerCode |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganization/@determinerCode |
| FHIR | no mapping |
| Notes | Fixed to "INSTANCE" |
| Item | code@code |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganization/code/@code |
| FHIR | organization/type/coding/code/@value |
| Notes | org type FHIR:Just use the code |
| Item | name |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganization/name |
| FHIR | organization/name/@value |
| Notes | |
| Item | desc |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganization/desc |
| FHIR | no mapping |
| Notes | |
| Item | addr |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganization/addr |
| FHIR | organization/address |
| Notes |
OrganizationSDS (if using this option)
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganizationSDS/@classCode |
| FHIR | no mapping |
| Notes | Fixed to "ORG" |
| Item | @determinerCode |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganizationSDS/@determinerCode |
| FHIR | no mapping |
| Notes | Fixed to "INSTANCE" |
| Item | id@root |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganizationSDS/id/@root |
| FHIR | organization/identifier/system/@value |
| Notes | HL7v3: Fixed to "1.2.826.0.1285.0.1.10" (for org) "1.2.826.0.1285.0.2.0.109" (for workgroup) FHIR: Fixed to "https://fhir.nhs.uk/Id/ods-organization-code" (for org); workgroup system id not available for workgroups |
| Item | id@extension |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganizationSDS/id/@extension |
| FHIR | organization/identifier/value/@value |
| Notes | The SDS Org ID, or SDS Workgroup ID |
| Item | name |
| HL7v3 | UKCT_MT160018UK01.AgentPerson/representedOrganizationSDS/name |
| FHIR | organization/name/@value |
| Notes |
PersonSDS (see above)
Person
| Mapping | |
|---|---|
| Item | @classCode |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPerson/@classCode |
| FHIR | no mapping |
| Notes | Fixed to "PSN" |
| Item | @determinerCode |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPerson/@determinerCode |
| FHIR | no mapping |
| Notes | Fixed to "INSTANCE" |
| Item | name |
| HL7v3 | UKCT_MT160018UK01.AgentPersonSDS/agentPerson/name |
| FHIR | Practitioner/name |
| Notes | Name of the author |
HL7v3
<UKCT_MT160018UK01.AgentPerson classCode="AGNT"> <code code="NR0260" codeSystem="2.16.840.1.113883.2.1.3.2.4.17.124" displayName="General Medical Practitioner"/> <addr use="WP">ORG ADDRESS</addr> <telecom use="WP" value="0177865579"/> <representedPerson classCode="PSN" determinerCode="INSTANCE"> <name>BLOGGS Fred</name> </representedPerson> </UKCT_MT160018UK01.AgentPerson>
FHIR
<PractitionerRole> <id value="83c26c8f-ee72-4534-8891-0136972b2106"/> <practitioner> <reference value="urn:uuid:b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> </practitioner> <organization> <reference value="a82b49f8-2780-47cc-aa4b-62f79aa4ade9"/> </organization> <code> <coding> <code value="NR0260"/> <dispaly value="General Medical Practitioner"/> <system value="https://fhir.nhs.uk/CodeSystem/HL7v3-SDSJobRoleName"/> </coding> </code> </PractitionerRole> <Practitioner> <id value="b1a41ee5-b88b-4f66-bd83-24343bf63dd8"/> <name> <family value="BLOGGS"/> <given value="Fred"/> </name> </Practitioner> <organization> <id value="a82b49f8-2780-47cc-aa4b-62f79aa4ade9"/> <name value="LEEDS TEACHING HOSPITAL TRUST"/> <telecom> <system value="phone"/> <value value="0177865579"/> </telecom> <address> <line value="ORG ADDRESS"/> </address> </organization>