NHS Digital FHIR Implementation Guide (Retired - 2.1.50)

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

ConceptMap

eps-issue-code-to-fhir-issue-type

Url
https://fhir.nhs.uk/ConceptMap/eps-issue-code-to-fhir-issue-type
Source CodeSystem Destination CodeSystem
https://fhir.nhs.uk/CodeSystem/EPS-IssueCode http://hl7.org/fhir/issue-type

SourceEquivalenceDestinationComment
PATIENT_DECEASED (Patient is recorded as dead)specializesbusiness-rule (Business Rule Violation)HTTP code: 422
DUPLICATE_PRESCRIPTION_ID (Duplicate prescription ID exists)specializesduplicate (Duplicate)HTTP code: 422
INVALID_NUMBER_MEDICATIONREQUEST (Number of items on a prescription should be between 1 and 4)specializesbusiness-rule (Business Rule Violation)HTTP code: 422
MISMATCH_AUTHORISED_REPEAT_COUNT (Mismatch in authorised repeat counts)specializesbusiness-rule (Business Rule Violation)HTTP code: 422
INVALID_REPEAT_COUNT (Repeat count should be between 1 and 99)specializesbusiness-rule (Business Rule Violation)HTTP code: 422
DUPLICATE_MEDICATIONREQUEST_ID (Duplicate item ID exists)specializesduplicate (Duplicate)HTTP code: 422
INVALID_CHECK_DIGIT (Error in check digit)specializesvalue (Element value invalid)HTTP code: 400
INVALID_MESSAGE (Invalid message)specializesstructure (Structural Issue)HTTP code: 400
{
    "resourceType": "ConceptMap",
    "id": "eps-issue-code-to-fhir-issue-type",
    "url": "https://fhir.nhs.uk/ConceptMap/eps-issue-code-to-fhir-issue-type",
    "version": "1.1.0",
    "name": "epsissuecodetofhirissuetype",
    "title": "EPS Issue Code to FHIR Issue Type Map",
    "status": "draft",
    "experimental": true,
    "date": "2020-08-05",
    "publisher": "NHS Digital",
    "description": "EPS Issue Code to FHIR Issue Type Map",
    "purpose": "NHS Digital Spine",
    "group":  [
        {
            "source": "https://fhir.nhs.uk/CodeSystem/EPS-IssueCode",
            "target": "http://hl7.org/fhir/issue-type",
            "element":  [
                {
                    "code": "PATIENT_DECEASED",
                    "display": "Patient is recorded as dead",
                    "target":  [
                        {
                            "code": "business-rule",
                            "display": "Business Rule Violation",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 422"
                        }
                    ]
                },
                {
                    "code": "DUPLICATE_PRESCRIPTION_ID",
                    "display": "Duplicate prescription ID exists",
                    "target":  [
                        {
                            "code": "duplicate",
                            "display": "Duplicate",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 422"
                        }
                    ]
                },
                {
                    "code": "INVALID_NUMBER_MEDICATIONREQUEST",
                    "display": "Number of items on a prescription should be between 1 and 4",
                    "target":  [
                        {
                            "code": "business-rule",
                            "display": "Business Rule Violation",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 422"
                        }
                    ]
                },
                {
                    "code": "MISMATCH_AUTHORISED_REPEAT_COUNT",
                    "display": "Mismatch in authorised repeat counts",
                    "target":  [
                        {
                            "code": "business-rule",
                            "display": "Business Rule Violation",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 422"
                        }
                    ]
                },
                {
                    "code": "INVALID_REPEAT_COUNT",
                    "display": "Repeat count should be between 1 and 99",
                    "target":  [
                        {
                            "code": "business-rule",
                            "display": "Business Rule Violation",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 422"
                        }
                    ]
                },
                {
                    "code": "DUPLICATE_MEDICATIONREQUEST_ID",
                    "display": "Duplicate item ID exists",
                    "target":  [
                        {
                            "code": "duplicate",
                            "display": "Duplicate",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 422"
                        }
                    ]
                },
                {
                    "code": "INVALID_CHECK_DIGIT",
                    "display": "Error in check digit",
                    "target":  [
                        {
                            "code": "value",
                            "display": "Element value invalid",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 400"
                        }
                    ]
                },
                {
                    "code": "INVALID_MESSAGE",
                    "display": "Invalid message",
                    "target":  [
                        {
                            "code": "structure",
                            "display": "Structural Issue",
                            "equivalence": "specializes",
                            "comment": "HTTP code: 400"
                        }
                    ]
                }
            ]
        }
    ]
}
<ConceptMap xmlns="http://hl7.org/fhir">
    <id value="eps-issue-code-to-fhir-issue-type" />
    <url value="https://fhir.nhs.uk/ConceptMap/eps-issue-code-to-fhir-issue-type" />
    <version value="1.1.0" />
    <name value="epsissuecodetofhirissuetype" />
    <title value="EPS Issue Code to FHIR Issue Type Map" />
    <status value="draft" />
    <experimental value="true" />
    <date value="2020-08-05" />
    <publisher value="NHS Digital" />
    <description value="EPS Issue Code to FHIR Issue Type Map" />
    <purpose value="NHS Digital Spine" />
    <group>
        <source value="https://fhir.nhs.uk/CodeSystem/EPS-IssueCode" />
        <target value="http://hl7.org/fhir/issue-type" />
        <element>
            <code value="PATIENT_DECEASED" />
            <display value="Patient is recorded as dead" />
            <target>
                <code value="business-rule" />
                <display value="Business Rule Violation" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 422" />
            </target>
        </element>
        <element>
            <code value="DUPLICATE_PRESCRIPTION_ID" />
            <display value="Duplicate prescription ID exists" />
            <target>
                <code value="duplicate" />
                <display value="Duplicate" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 422" />
            </target>
        </element>
        <element>
            <code value="INVALID_NUMBER_MEDICATIONREQUEST" />
            <display value="Number of items on a prescription should be between 1 and 4" />
            <target>
                <code value="business-rule" />
                <display value="Business Rule Violation" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 422" />
            </target>
        </element>
        <element>
            <code value="MISMATCH_AUTHORISED_REPEAT_COUNT" />
            <display value="Mismatch in authorised repeat counts" />
            <target>
                <code value="business-rule" />
                <display value="Business Rule Violation" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 422" />
            </target>
        </element>
        <element>
            <code value="INVALID_REPEAT_COUNT" />
            <display value="Repeat count should be between 1 and 99" />
            <target>
                <code value="business-rule" />
                <display value="Business Rule Violation" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 422" />
            </target>
        </element>
        <element>
            <code value="DUPLICATE_MEDICATIONREQUEST_ID" />
            <display value="Duplicate item ID exists" />
            <target>
                <code value="duplicate" />
                <display value="Duplicate" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 422" />
            </target>
        </element>
        <element>
            <code value="INVALID_CHECK_DIGIT" />
            <display value="Error in check digit" />
            <target>
                <code value="value" />
                <display value="Element value invalid" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 400" />
            </target>
        </element>
        <element>
            <code value="INVALID_MESSAGE" />
            <display value="Invalid message" />
            <target>
                <code value="structure" />
                <display value="Structural Issue" />
                <equivalence value="specializes" />
                <comment value="HTTP code: 400" />
            </target>
        </element>
    </group>
</ConceptMap>

issueType-to-http-status-code

Url
https://fhir.nhs.uk/ConceptMap/issueType-to-http-status-code
Source CodeSystem Destination CodeSystem
http://hl7.org/fhir/issue-type http://hl7.org/fhir/http-status-code (for reference only, not an actual CodeSystem)

SourceEquivalenceDestinationComment
not-found (Not Found)specializes404 (Not Found)
value (Element value invalid)specializes400 (Bad Request)
business-rule (Business Rule Violation)specializes400 (Bad Request)Should be 422?
invalid (Invalid Content)specializes400 (Bad Request)
invalid (Invalid Content)specializes422 (UNPROCESSABLE_ENTITY)Should be 400?
code-invalid (Invalid Code)specializes400 (BAD REQUEST)Should be 422?
forbidden (Forbidden)specializes403 (Forbidden)
forbidden (Forbidden)specializes401 (CLIENT_UNAUTHORIZED)Wrong issueType - login/unknown better?
forbidden (Forbidden)specializes405 (METHOD_NOT_ALLOWED)Is 405 more suited to wrong http verb being used. This should still be 403
duplicate (Duplicate)specializes422 (UNPROCESSABLE_ENTITY)
structure (Structural Issue)specializes400 (BAD REQUEST)
not-supported (Content not supported)specializes501 (NOT_IMPLEMENTED)
processing (Processing Failure)specializes500 (INTERNAL_ERROR)Mapping is wrong here. processing should be 422
informational (Informational Note)specializes201 (CREATED)
informational (Informational Note)specializes200 (OK)
informational (Informational Note)specializes202 (ACCEPTED)
{
    "resourceType": "ConceptMap",
    "id": "issueType-to-http-status-code",
    "url": "https://fhir.nhs.uk/ConceptMap/issueType-to-http-status-code",
    "version": "1.0.0",
    "name": "issueTypetohttpstatuscode",
    "title": "issueType-to-http-status-code",
    "status": "draft",
    "experimental": true,
    "date": "2020-08-05",
    "publisher": "NHS Digital",
    "description": "issueType-to-http-status-code for illustration only. Mapping extracted from HAPI FHIR",
    "purpose": "NHS Digital Spine",
    "group":  [
        {
            "source": "http://hl7.org/fhir/issue-type",
            "target": "http://hl7.org/fhir/http-status-code",
            "element":  [
                {
                    "code": "not-found",
                    "display": "Not Found",
                    "target":  [
                        {
                            "code": "404",
                            "display": "Not Found",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "value",
                    "display": "Element value invalid",
                    "target":  [
                        {
                            "code": "400",
                            "display": "Bad Request",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "business-rule",
                    "display": "Business Rule Violation",
                    "target":  [
                        {
                            "code": "400",
                            "display": "Bad Request",
                            "equivalence": "specializes",
                            "comment": "Should be 422?"
                        }
                    ]
                },
                {
                    "code": "invalid",
                    "display": "Invalid Content",
                    "target":  [
                        {
                            "code": "400",
                            "display": "Bad Request",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "invalid",
                    "display": "Invalid Content",
                    "target":  [
                        {
                            "code": "422",
                            "display": "UNPROCESSABLE_ENTITY",
                            "equivalence": "specializes",
                            "comment": "Should be 400?"
                        }
                    ]
                },
                {
                    "code": "code-invalid",
                    "display": "Invalid Code",
                    "target":  [
                        {
                            "code": "400",
                            "display": "BAD REQUEST",
                            "equivalence": "specializes",
                            "comment": "Should be 422?"
                        }
                    ]
                },
                {
                    "code": "forbidden",
                    "display": "Forbidden",
                    "target":  [
                        {
                            "code": "403",
                            "display": "Forbidden",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "forbidden",
                    "display": "Forbidden",
                    "target":  [
                        {
                            "code": "401",
                            "display": "CLIENT_UNAUTHORIZED",
                            "equivalence": "specializes",
                            "comment": "Wrong issueType - login/unknown better?"
                        }
                    ]
                },
                {
                    "code": "forbidden",
                    "display": "Forbidden",
                    "target":  [
                        {
                            "code": "405",
                            "display": "METHOD_NOT_ALLOWED",
                            "equivalence": "specializes",
                            "comment": "Is 405 more suited to wrong http verb being used. This should still be 403"
                        }
                    ]
                },
                {
                    "code": "duplicate",
                    "display": "Duplicate",
                    "target":  [
                        {
                            "code": "422",
                            "display": "UNPROCESSABLE_ENTITY",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "structure",
                    "display": "Structural Issue",
                    "target":  [
                        {
                            "code": "400",
                            "display": "BAD REQUEST",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "not-supported",
                    "display": "Content not supported",
                    "target":  [
                        {
                            "code": "501",
                            "display": "NOT_IMPLEMENTED",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "processing",
                    "display": "Processing Failure",
                    "target":  [
                        {
                            "code": "500",
                            "display": "INTERNAL_ERROR",
                            "equivalence": "specializes",
                            "comment": "Mapping is wrong here. processing should be 422"
                        }
                    ]
                },
                {
                    "code": "informational",
                    "display": "Informational Note",
                    "target":  [
                        {
                            "code": "201",
                            "display": "CREATED",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "informational",
                    "display": "Informational Note",
                    "target":  [
                        {
                            "code": "200",
                            "display": "OK",
                            "equivalence": "specializes"
                        }
                    ]
                },
                {
                    "code": "informational",
                    "display": "Informational Note",
                    "target":  [
                        {
                            "code": "202",
                            "display": "ACCEPTED",
                            "equivalence": "specializes"
                        }
                    ]
                }
            ]
        }
    ]
}
<ConceptMap xmlns="http://hl7.org/fhir">
    <id value="issueType-to-http-status-code" />
    <url value="https://fhir.nhs.uk/ConceptMap/issueType-to-http-status-code" />
    <version value="1.0.0" />
    <name value="issueTypetohttpstatuscode" />
    <title value="issueType-to-http-status-code" />
    <status value="draft" />
    <experimental value="true" />
    <date value="2020-08-05" />
    <publisher value="NHS Digital" />
    <description value="issueType-to-http-status-code for illustration only. Mapping extracted from HAPI FHIR" />
    <purpose value="NHS Digital Spine" />
    <group>
        <source value="http://hl7.org/fhir/issue-type" />
        <target value="http://hl7.org/fhir/http-status-code" />
        <element>
            <code value="not-found" />
            <display value="Not Found" />
            <target>
                <code value="404" />
                <display value="Not Found" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="value" />
            <display value="Element value invalid" />
            <target>
                <code value="400" />
                <display value="Bad Request" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="business-rule" />
            <display value="Business Rule Violation" />
            <target>
                <code value="400" />
                <display value="Bad Request" />
                <equivalence value="specializes" />
                <comment value="Should be 422?" />
            </target>
        </element>
        <element>
            <code value="invalid" />
            <display value="Invalid Content" />
            <target>
                <code value="400" />
                <display value="Bad Request" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="invalid" />
            <display value="Invalid Content" />
            <target>
                <code value="422" />
                <display value="UNPROCESSABLE_ENTITY" />
                <equivalence value="specializes" />
                <comment value="Should be 400?" />
            </target>
        </element>
        <element>
            <code value="code-invalid" />
            <display value="Invalid Code" />
            <target>
                <code value="400" />
                <display value="BAD REQUEST" />
                <equivalence value="specializes" />
                <comment value="Should be 422?" />
            </target>
        </element>
        <element>
            <code value="forbidden" />
            <display value="Forbidden" />
            <target>
                <code value="403" />
                <display value="Forbidden" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="forbidden" />
            <display value="Forbidden" />
            <target>
                <code value="401" />
                <display value="CLIENT_UNAUTHORIZED" />
                <equivalence value="specializes" />
                <comment value="Wrong issueType - login/unknown better?" />
            </target>
        </element>
        <element>
            <code value="forbidden" />
            <display value="Forbidden" />
            <target>
                <code value="405" />
                <display value="METHOD_NOT_ALLOWED" />
                <equivalence value="specializes" />
                <comment value="Is 405 more suited to wrong http verb being used. This should still be 403" />
            </target>
        </element>
        <element>
            <code value="duplicate" />
            <display value="Duplicate" />
            <target>
                <code value="422" />
                <display value="UNPROCESSABLE_ENTITY" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="structure" />
            <display value="Structural Issue" />
            <target>
                <code value="400" />
                <display value="BAD REQUEST" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="not-supported" />
            <display value="Content not supported" />
            <target>
                <code value="501" />
                <display value="NOT_IMPLEMENTED" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="processing" />
            <display value="Processing Failure" />
            <target>
                <code value="500" />
                <display value="INTERNAL_ERROR" />
                <equivalence value="specializes" />
                <comment value="Mapping is wrong here. processing should be 422" />
            </target>
        </element>
        <element>
            <code value="informational" />
            <display value="Informational Note" />
            <target>
                <code value="201" />
                <display value="CREATED" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="informational" />
            <display value="Informational Note" />
            <target>
                <code value="200" />
                <display value="OK" />
                <equivalence value="specializes" />
            </target>
        </element>
        <element>
            <code value="informational" />
            <display value="Informational Note" />
            <target>
                <code value="202" />
                <display value="ACCEPTED" />
                <equivalence value="specializes" />
            </target>
        </element>
    </group>
</ConceptMap>

organisation-role-to-organisation-type

Url
https://fhir.nhs.uk/ConceptMap/organisation-role-to-organisation-type
Source CodeSystem Destination CodeSystem
organisationrole organisationtype

SourceEquivalenceDestination
197 (NHS TRUST)equivalent008 (Acute Trust)
197 (NHS TRUST)equivalent009 (Care Trust)
197 (NHS TRUST)equivalent010 (Community Trust)
{
    "resourceType": "ConceptMap",
    "id": "organisation-role-to-organisation-type",
    "url": "https://fhir.nhs.uk/ConceptMap/organisation-role-to-organisation-type",
    "version": "1.0.0",
    "name": "organisationroletoorganisationtype",
    "title": "organisation-role-to-organisation-type",
    "status": "draft",
    "experimental": true,
    "date": "2020-08-05",
    "publisher": "NHS Digital",
    "description": "organisation-role-to-organisation-type",
    "purpose": "NHS Digital Spine",
    "group":  [
        {
            "source": "https://fhir.nhs.uk/CodeSystem/organisation-role",
            "target": "https://fhir.nhs.uk/CodeSystem/organisation-type",
            "element":  [
                {
                    "code": "197",
                    "display": "NHS TRUST",
                    "target":  [
                        {
                            "code": "008",
                            "display": "Acute Trust",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "197",
                    "display": "NHS TRUST",
                    "target":  [
                        {
                            "code": "009",
                            "display": "Care Trust",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "197",
                    "display": "NHS TRUST",
                    "target":  [
                        {
                            "code": "010",
                            "display": "Community Trust",
                            "equivalence": "equivalent"
                        }
                    ]
                }
            ]
        }
    ]
}
<ConceptMap xmlns="http://hl7.org/fhir">
    <id value="organisation-role-to-organisation-type" />
    <url value="https://fhir.nhs.uk/ConceptMap/organisation-role-to-organisation-type" />
    <version value="1.0.0" />
    <name value="organisationroletoorganisationtype" />
    <title value="organisation-role-to-organisation-type" />
    <status value="draft" />
    <experimental value="true" />
    <date value="2020-08-05" />
    <publisher value="NHS Digital" />
    <description value="organisation-role-to-organisation-type" />
    <purpose value="NHS Digital Spine" />
    <group>
        <source value="https://fhir.nhs.uk/CodeSystem/organisation-role" />
        <target value="https://fhir.nhs.uk/CodeSystem/organisation-type" />
        <element>
            <code value="197" />
            <display value="NHS TRUST" />
            <target>
                <code value="008" />
                <display value="Acute Trust" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="197" />
            <display value="NHS TRUST" />
            <target>
                <code value="009" />
                <display value="Care Trust" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="197" />
            <display value="NHS TRUST" />
            <target>
                <code value="010" />
                <display value="Community Trust" />
                <equivalence value="equivalent" />
            </target>
        </element>
    </group>
</ConceptMap>

name-use-v2-hscic

Url
https://fhir.nhs.uk/ConceptMap/name-use-v2-hscic
Source CodeSystem Destination CodeSystem
NameUse v2.0200

Mapping from NameUse

SourceEquivalenceDestination
usualequivalentD
officialequivalentL
nicknameequivalentN
anonymousequivalentS
maidenequivalentM
{
    "resourceType": "ConceptMap",
    "id": "name-use-v2-hscic",
    "text": {
        "status": "generated",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "https://fhir.nhs.uk/ConceptMap/name-use-v2-hscic",
    "version": "1.0.0",
    "name": "HSCICv2NameUse",
    "title": "HSCIC v2 map for NameUse",
    "status": "draft",
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "NHS Digital",
    "contact":  [
        {
            "name": "Interoperability Team",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work"
                }
            ]
        }
    ],
    "sourceCanonical": "http://hl7.org/fhir/ValueSet/name-use",
    "targetCanonical": "https://fhir.nhs.uk/ValueSet/v2-hscic-0200-NameType",
    "group":  [
        {
            "source": "http://hl7.org/fhir/name-use",
            "target": "http://terminology.hl7.org/CodeSystem/v2-0200",
            "element":  [
                {
                    "code": "usual",
                    "target":  [
                        {
                            "code": "D",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "official",
                    "target":  [
                        {
                            "code": "L",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "nickname",
                    "target":  [
                        {
                            "code": "N",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "anonymous",
                    "target":  [
                        {
                            "code": "S",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "maiden",
                    "target":  [
                        {
                            "code": "M",
                            "equivalence": "equivalent"
                        }
                    ]
                }
            ]
        }
    ]
}
<ConceptMap xmlns="http://hl7.org/fhir">
    <id value="name-use-v2-hscic" />
    <text>
        <status value="generated" />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <url value="https://fhir.nhs.uk/ConceptMap/name-use-v2-hscic" />
    <version value="1.0.0" />
    <name value="HSCICv2NameUse" />
    <title value="HSCIC v2 map for NameUse" />
    <status value="draft" />
    <date value="2019-11-01T09:29:23+11:00" />
    <publisher value="NHS Digital" />
    <contact>
        <name value="Interoperability Team" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
        </telecom>
    </contact>
    <sourceCanonical value="http://hl7.org/fhir/ValueSet/name-use" />
    <targetCanonical value="https://fhir.nhs.uk/ValueSet/v2-hscic-0200-NameType" />
    <group>
        <source value="http://hl7.org/fhir/name-use" />
        <target value="http://terminology.hl7.org/CodeSystem/v2-0200" />
        <element>
            <code value="usual" />
            <target>
                <code value="D" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="official" />
            <target>
                <code value="L" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="nickname" />
            <target>
                <code value="N" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="anonymous" />
            <target>
                <code value="S" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="maiden" />
            <target>
                <code value="M" />
                <equivalence value="equivalent" />
            </target>
        </element>
    </group>
</ConceptMap>

name-use-v3-npfit

Url
https://fhir.nhs.uk/ConceptMap/name-use-v3-npfit
Source CodeSystem Destination CodeSystem
NameUse v3.EntityNameUse
NameUse v3npfitnameuse

SourceEquivalenceDestination
usual (Usual)equalL (Legal)
official (Official)subsumesL (Legal)
temp (Temp)subsumesA (Artist/Stage)
anonymous (Anonymous)equivalentA (Artist/Stage)
SourceEquivalenceDestination
nickname (Nickname)subsumesPREFERRED (Preferred name)
old (Old)equivalentPREVIOUS (Other previous name)
maiden (Name changed for Marriage)equalPREVIOUS-MAIDEN (Maiden name)
{
    "resourceType": "ConceptMap",
    "id": "name-use-v3-npfit",
    "url": "https://fhir.nhs.uk/ConceptMap/name-use-v3-npfit",
    "version": "1.0.0",
    "name": "NPfITv3NameUse",
    "title": "NPfIT v3.NameUse",
    "status": "draft",
    "experimental": true,
    "date": "2020-10-15",
    "publisher": "NHS Digital",
    "description": "NPfIT v3.NameUse",
    "purpose": "NHS Digital Spine",
    "group":  [
        {
            "source": "http://hl7.org/fhir/name-use",
            "target": "http://terminology.hl7.org/CodeSystem/v3-EntityNameUse",
            "element":  [
                {
                    "code": "usual",
                    "display": "Usual",
                    "target":  [
                        {
                            "code": "L",
                            "display": "Legal",
                            "equivalence": "equal"
                        }
                    ]
                },
                {
                    "code": "official",
                    "display": "Official",
                    "target":  [
                        {
                            "code": "L",
                            "display": "Legal",
                            "equivalence": "subsumes"
                        }
                    ]
                },
                {
                    "code": "temp",
                    "display": "Temp",
                    "target":  [
                        {
                            "code": "A",
                            "display": "Artist/Stage",
                            "equivalence": "subsumes"
                        }
                    ]
                },
                {
                    "code": "anonymous",
                    "display": "Anonymous",
                    "target":  [
                        {
                            "code": "A",
                            "display": "Artist/Stage",
                            "equivalence": "equivalent"
                        }
                    ]
                }
            ]
        },
        {
            "source": "http://hl7.org/fhir/name-use",
            "target": "https://fhir.nhs.uk/CodeSystem/v3-npfit-nameuse",
            "element":  [
                {
                    "code": "nickname",
                    "display": "Nickname",
                    "target":  [
                        {
                            "code": "PREFERRED",
                            "display": "Preferred name",
                            "equivalence": "subsumes"
                        }
                    ]
                },
                {
                    "code": "old",
                    "display": "Old",
                    "target":  [
                        {
                            "code": "PREVIOUS",
                            "display": "Other previous name",
                            "equivalence": "equivalent"
                        }
                    ]
                },
                {
                    "code": "maiden",
                    "display": "Name changed for Marriage",
                    "target":  [
                        {
                            "code": "PREVIOUS-MAIDEN",
                            "display": "Maiden name",
                            "equivalence": "equal"
                        }
                    ]
                }
            ]
        }
    ]
}
<ConceptMap xmlns="http://hl7.org/fhir">
    <id value="name-use-v3-npfit" />
    <url value="https://fhir.nhs.uk/ConceptMap/name-use-v3-npfit" />
    <version value="1.0.0" />
    <name value="NPfITv3NameUse" />
    <title value="NPfIT v3.NameUse" />
    <status value="draft" />
    <experimental value="true" />
    <date value="2020-10-15" />
    <publisher value="NHS Digital" />
    <description value="NPfIT v3.NameUse" />
    <purpose value="NHS Digital Spine" />
    <group>
        <source value="http://hl7.org/fhir/name-use" />
        <target value="http://terminology.hl7.org/CodeSystem/v3-EntityNameUse" />
        <element>
            <code value="usual" />
            <display value="Usual" />
            <target>
                <code value="L" />
                <display value="Legal" />
                <equivalence value="equal" />
            </target>
        </element>
        <element>
            <code value="official" />
            <display value="Official" />
            <target>
                <code value="L" />
                <display value="Legal" />
                <equivalence value="subsumes" />
            </target>
        </element>
        <element>
            <code value="temp" />
            <display value="Temp" />
            <target>
                <code value="A" />
                <display value="Artist/Stage" />
                <equivalence value="subsumes" />
            </target>
        </element>
        <element>
            <code value="anonymous" />
            <display value="Anonymous" />
            <target>
                <code value="A" />
                <display value="Artist/Stage" />
                <equivalence value="equivalent" />
            </target>
        </element>
    </group>
    <group>
        <source value="http://hl7.org/fhir/name-use" />
        <target value="https://fhir.nhs.uk/CodeSystem/v3-npfit-nameuse" />
        <element>
            <code value="nickname" />
            <display value="Nickname" />
            <target>
                <code value="PREFERRED" />
                <display value="Preferred name" />
                <equivalence value="subsumes" />
            </target>
        </element>
        <element>
            <code value="old" />
            <display value="Old" />
            <target>
                <code value="PREVIOUS" />
                <display value="Other previous name" />
                <equivalence value="equivalent" />
            </target>
        </element>
        <element>
            <code value="maiden" />
            <display value="Name changed for Marriage" />
            <target>
                <code value="PREVIOUS-MAIDEN" />
                <display value="Maiden name" />
                <equivalence value="equal" />
            </target>
        </element>
    </group>
</ConceptMap>

back to top