UK Core Implementation Guide STU3 Sequence - Sprint 6 Review

StructureDefinition-UKCore-Patient

Description

This profile defines the UK constraints and extensions on the International FHIR resource Patient.

ProfilePurpose

This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services.

Snapshot View

url1..1System.StringFixed Value
valueAddressAddress
birthSexI0..1Extension(code)
url1..1System.StringFixed Value
valueBooleanboolean
contactPreferenceI0..1Extension(Complex)
deathNotificationStatusI0..1Extension(Complex)
ethnicCategoryI0..1Extension(CodeableConcept)
residentialStatusI0..1Extension(CodeableConcept)
url1..1System.StringFixed Value
valueBooleanboolean
nhsNumberVerificationStatusI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
nameΣ0..*HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
url1..1System.StringFixed Value
valueDateTimedateTime
deceasedBooleanboolean
deceasedDateTimedateTime
addressKeyI0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
contactRankI0..1Extension(positiveInt)
copyCorrespondenceIndicatorI0..1Extension(boolean)
relationship0..*CodeableConceptBinding
name0..1HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
address0..1Address
gender0..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
periodI0..1Period
url1..1uriFixed Value
valueCodingCoding
url1..1uriFixed Value
valueCodingCoding
url1..1System.StringFixed Value
language1..1CodeableConceptBinding
preferred0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
typeΣ1..1codeBinding

Differential View

url1..1System.StringFixed Value
valueAddressAddress
birthSexI0..1Extension(code)
url1..1System.StringFixed Value
valueBooleanboolean
contactPreferenceI0..1Extension(Complex)
deathNotificationStatusI0..1Extension(Complex)
ethnicCategoryI0..1Extension(CodeableConcept)
residentialStatusI0..1Extension(CodeableConcept)
url1..1System.StringFixed Value
valueBooleanboolean
nhsNumberVerificationStatusI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
nameΣ0..*HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
url1..1System.StringFixed Value
valueDateTimedateTime
deceasedBooleanboolean
deceasedDateTimedateTime
addressKeyI0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
contactRankI0..1Extension(positiveInt)
copyCorrespondenceIndicatorI0..1Extension(boolean)
relationship0..*CodeableConceptBinding
name0..1HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
address0..1Address
gender0..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
periodI0..1Period
url1..1uriFixed Value
valueCodingCoding
url1..1uriFixed Value
valueCodingCoding
url1..1System.StringFixed Value
language1..1CodeableConceptBinding
preferred0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
typeΣ1..1codeBinding

Hybrid View

url1..1System.StringFixed Value
valueAddressAddress
birthSexI0..1Extension(code)
url1..1System.StringFixed Value
valueBooleanboolean
contactPreferenceI0..1Extension(Complex)
deathNotificationStatusI0..1Extension(Complex)
ethnicCategoryI0..1Extension(CodeableConcept)
residentialStatusI0..1Extension(CodeableConcept)
url1..1System.StringFixed Value
valueBooleanboolean
nhsNumberVerificationStatusI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
nameΣ0..*HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
genderΣ0..1codeBinding
url1..1System.StringFixed Value
valueDateTimedateTime
deceasedBooleanboolean
deceasedDateTimedateTime
addressKeyI0..*Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
contactRankI0..1Extension(positiveInt)
copyCorrespondenceIndicatorI0..1Extension(boolean)
relationship0..*CodeableConceptBinding
name0..1HumanName
otherContactSystemI0..1Extension(Coding)
valueΣ0..1string
useΣ ?!0..1codeBinding
rankΣ0..1positiveInt
periodΣ I0..1Period
address0..1Address
gender0..1codeBinding
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
periodI0..1Period
url1..1uriFixed Value
valueCodingCoding
url1..1uriFixed Value
valueCodingCoding
url1..1System.StringFixed Value
language1..1CodeableConceptBinding
preferred0..1boolean
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
typeΣ1..1codeBinding

Table View

Patient..
Patient.extension0..
Patient.extensionExtension0..
Patient.extension.value[x]..
Patient.extensionExtension0..
Patient.extensionExtension0..
Patient.extension.value[x]..
Patient.extensionExtension0..
Patient.extensionExtension0..
Patient.extensionExtension0..1
Patient.extensionExtension0..
Patient.extensionExtension0..
Patient.extension.value[x]..
Patient.identifier..
Patient.identifier..1
Patient.identifier.extension0..
Patient.identifier.extensionExtension0..1
Patient.identifier.system1..
Patient.identifier.value1..
Patient.identifier.assignerReference(UK Core Organization)..
Patient.telecom..
Patient.telecom.system..
Patient.telecom.system.extension0..
Patient.telecom.system.extensionExtension0..
Patient.birthDate..
Patient.birthDate.extension0..
Patient.birthDate.extensionExtension0..
Patient.birthDate.extension.value[x]..
Patient.address..
Patient.address.extension0..
Patient.address.extensionExtension0..
Patient.maritalStatus..
Patient.contact..
Patient.contact.extension0..
Patient.contact.extensionExtension0..
Patient.contact.extensionExtension0..
Patient.contact.relationship..
Patient.contact.telecom..
Patient.contact.telecom.system..
Patient.contact.telecom.system.extension0..
Patient.contact.telecom.system.extensionExtension0..
Patient.contact.organizationReference(UK Core Organization)..
Patient.contact.organization.identifier..
Patient.contact.organization.identifier.assignerReference(UK Core Organization)..
Patient.communication..
Patient.communication.extension0..
Patient.communication.extensionExtension0..1
Patient.communication.extension.extension0..
Patient.communication.extension.extension0..
Patient.communication.extension.extension.value[x]..
Patient.communication.extension.extension0..
Patient.communication.extension.extension.value[x]..
Patient.communication.language..
Patient.generalPractitionerReference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole)..
Patient.generalPractitioner.identifier..
Patient.generalPractitioner.identifier.assignerReference(UK Core Organization)..
Patient.managingOrganizationReference(UK Core Organization)..
Patient.managingOrganization.identifier..
Patient.managingOrganization.identifier.assignerReference(UK Core Organization)..
Patient.link..
Patient.link.otherReference(UK Core Patient | UK Core RelatedPerson)..
Patient.link.other.identifier..
Patient.link.other.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Patient" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
    <version value="2.3.0" />
    <name value="UKCorePatient" />
    <title value="UK Core Patient" />
    <status value="active" />
    <date value="2022-12-16" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Patient](https://hl7.org/fhir/R4/Patient.html)." />
    <purpose value="This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="cda" />
        <uri value="http://hl7.org/v3/cda" />
        <name value="CDA (R2)" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <mapping>
        <identity value="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="loinc" />
        <uri value="http://loinc.org" />
        <name value="LOINC code for the element" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Patient" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Patient" />
    <derivation value="constraint" />
    <differential>
        <element id="Patient.extension">
            <path value="Patient.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.extension:birthPlace">
            <path value="Patient.extension" />
            <sliceName value="birthPlace" />
            <short value="The registered place of birth of the patient." />
            <definition value="The registered place of birth of the patient." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/patient-birthPlace" />
            </type>
        </element>
        <element id="Patient.extension:birthPlace.value[x]">
            <path value="Patient.extension.value[x]" />
            <short value="The registered place of birth of the patient." />
        </element>
        <element id="Patient.extension:birthSex">
            <path value="Patient.extension" />
            <sliceName value="birthSex" />
            <short value="The patient&#39;s phenotypic sex at birth." />
            <definition value="The patient&#39;s phenotypic sex at birth." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" />
            </type>
        </element>
        <element id="Patient.extension:cadavericDonor">
            <path value="Patient.extension" />
            <sliceName value="cadavericDonor" />
            <short value="Post-mortem donor status." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" />
            </type>
        </element>
        <element id="Patient.extension:cadavericDonor.value[x]">
            <path value="Patient.extension.value[x]" />
            <short value="Post-mortem donor status." />
            <definition value="Flag indicating whether the patient authorized the donation of body parts after death." />
        </element>
        <element id="Patient.extension:contactPreference">
            <path value="Patient.extension" />
            <sliceName value="contactPreference" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" />
            </type>
        </element>
        <element id="Patient.extension:deathNotificationStatus">
            <path value="Patient.extension" />
            <sliceName value="deathNotificationStatus" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" />
            </type>
        </element>
        <element id="Patient.extension:ethnicCategory">
            <path value="Patient.extension" />
            <sliceName value="ethnicCategory" />
            <short value="The ethnicity of the subject" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory" />
            </type>
        </element>
        <element id="Patient.extension:residentialStatus">
            <path value="Patient.extension" />
            <sliceName value="residentialStatus" />
            <short value="The residential status of the patient." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" />
            </type>
        </element>
        <element id="Patient.extension:patientInterpreterRequired">
            <path value="Patient.extension" />
            <sliceName value="patientInterpreterRequired" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" />
            </type>
        </element>
        <element id="Patient.extension:patientInterpreterRequired.value[x]">
            <path value="Patient.extension.value[x]" />
            <short value="Indicator showing whether the patient needs an interpreter" />
            <definition value="Indicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner." />
        </element>
        <element id="Patient.identifier">
            <path value="Patient.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
        </element>
        <element id="Patient.identifier:nhsNumber">
            <path value="Patient.identifier" />
            <sliceName value="nhsNumber" />
            <short value="The patient&#39;s NHS number" />
            <max value="1" />
        </element>
        <element id="Patient.identifier:nhsNumber.extension">
            <path value="Patient.identifier.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus">
            <path value="Patient.identifier.extension" />
            <sliceName value="nhsNumberVerificationStatus" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" />
            </type>
        </element>
        <element id="Patient.identifier:nhsNumber.system">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="normative" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
                <valueCode value="4.0.0" />
            </extension>
            <path value="Patient.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/nhs-number" />
        </element>
        <element id="Patient.identifier:nhsNumber.value">
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
                <valueCode value="normative" />
            </extension>
            <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
                <valueCode value="4.0.0" />
            </extension>
            <path value="Patient.identifier.value" />
            <min value="1" />
        </element>
        <element id="Patient.identifier:nhsNumber.assigner">
            <path value="Patient.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Patient.telecom.system.extension">
            <path value="Patient.telecom.system.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.telecom.system.extension:otherContactSystem">
            <path value="Patient.telecom.system.extension" />
            <sliceName value="otherContactSystem" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" />
            </type>
        </element>
        <element id="Patient.birthDate.extension">
            <path value="Patient.birthDate.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.birthDate.extension:birthTime">
            <path value="Patient.birthDate.extension" />
            <sliceName value="birthTime" />
            <short value="Time of day of birth." />
            <definition value="The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/patient-birthTime" />
            </type>
        </element>
        <element id="Patient.birthDate.extension:birthTime.value[x]">
            <path value="Patient.birthDate.extension.value[x]" />
            <short value="Time of day of birth." />
            <definition value="The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively." />
        </element>
        <element id="Patient.address">
            <path value="Patient.address" />
            <definition value="An address for the individual" />
        </element>
        <element id="Patient.address.extension">
            <path value="Patient.address.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.address.extension:addressKey">
            <path value="Patient.address.extension" />
            <sliceName value="addressKey" />
            <short value="A patient&#39;s address key and type" />
            <definition value="A patient&#39;s address key and type." />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" />
            </type>
        </element>
        <element id="Patient.maritalStatus">
            <path value="Patient.maritalStatus" />
            <binding>
                <strength value="extensible" />
                <description value="An indicator to identify the legal marital status of a person" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode" />
            </binding>
        </element>
        <element id="Patient.contact.extension">
            <path value="Patient.contact.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.contact.extension:contactRank">
            <path value="Patient.contact.extension" />
            <sliceName value="contactRank" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" />
            </type>
        </element>
        <element id="Patient.contact.extension:copyCorrespondenceIndicator">
            <path value="Patient.contact.extension" />
            <sliceName value="copyCorrespondenceIndicator" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" />
            </type>
        </element>
        <element id="Patient.contact.relationship">
            <path value="Patient.contact.relationship" />
            <binding>
                <strength value="extensible" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" />
            </binding>
        </element>
        <element id="Patient.contact.telecom.system.extension">
            <path value="Patient.contact.telecom.system.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.contact.telecom.system.extension:otherContactSystem">
            <path value="Patient.contact.telecom.system.extension" />
            <sliceName value="otherContactSystem" />
            <min value="0" />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" />
            </type>
        </element>
        <element id="Patient.contact.organization">
            <path value="Patient.contact.organization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Patient.contact.organization.identifier.assigner">
            <path value="Patient.contact.organization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Patient.communication.extension">
            <path value="Patient.communication.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.communication.extension:proficiency">
            <path value="Patient.communication.extension" />
            <sliceName value="proficiency" />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/patient-proficiency" />
            </type>
        </element>
        <element id="Patient.communication.extension:proficiency.extension">
            <path value="Patient.communication.extension.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="0" />
        </element>
        <element id="Patient.communication.extension:proficiency.extension:level">
            <path value="Patient.communication.extension.extension" />
            <sliceName value="level" />
            <min value="0" />
        </element>
        <element id="Patient.communication.extension:proficiency.extension:level.value[x]">
            <path value="Patient.communication.extension.extension.value[x]" />
            <short value="The proficiency level for the communication" />
            <definition value="The proficiency level for the communication." />
        </element>
        <element id="Patient.communication.extension:proficiency.extension:type">
            <path value="Patient.communication.extension.extension" />
            <sliceName value="type" />
            <min value="0" />
        </element>
        <element id="Patient.communication.extension:proficiency.extension:type.value[x]">
            <path value="Patient.communication.extension.extension.value[x]" />
            <short value="The proficiency type for the communication" />
            <definition value="The proficiency type for the communication." />
        </element>
        <element id="Patient.communication.language">
            <path value="Patient.communication.language" />
            <short value="A ValueSet that identifies the language used by a person." />
            <definition value="A ValueSet that identifies the language used by a person." />
            <binding>
                <strength value="extensible" />
                <description value="A ValueSet that identifies the language used by a person." />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage" />
            </binding>
        </element>
        <element id="Patient.generalPractitioner">
            <path value="Patient.generalPractitioner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole" />
            </type>
        </element>
        <element id="Patient.generalPractitioner.identifier.assigner">
            <path value="Patient.generalPractitioner.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Patient.managingOrganization">
            <path value="Patient.managingOrganization" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Patient.managingOrganization.identifier.assigner">
            <path value="Patient.managingOrganization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Patient.link.other">
            <path value="Patient.link.other" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" />
            </type>
        </element>
        <element id="Patient.link.other.identifier.assigner">
            <path value="Patient.link.other.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Patient",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
    "version": "2.3.0",
    "name": "UKCorePatient",
    "title": "UK Core Patient",
    "status": "active",
    "date": "2022-12-16",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Patient](https://hl7.org/fhir/R4/Patient.html).",
    "purpose": "This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services.",
    "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "cda",
            "uri": "http://hl7.org/v3/cda",
            "name": "CDA (R2)"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        },
        {
            "identity": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "loinc",
            "uri": "http://loinc.org",
            "name": "LOINC code for the element"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Patient",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Patient.extension",
                "path": "Patient.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.extension:birthPlace",
                "path": "Patient.extension",
                "sliceName": "birthPlace",
                "short": "The registered place of birth of the patient.",
                "definition": "The registered place of birth of the patient.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:birthPlace.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "The registered place of birth of the patient."
            },
            {
                "id": "Patient.extension:birthSex",
                "path": "Patient.extension",
                "sliceName": "birthSex",
                "short": "The patient's phenotypic sex at birth.",
                "definition": "The patient's phenotypic sex at birth.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:cadavericDonor",
                "path": "Patient.extension",
                "sliceName": "cadavericDonor",
                "short": "Post-mortem donor status.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:cadavericDonor.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "Post-mortem donor status.",
                "definition": "Flag indicating whether the patient authorized the donation of body parts after death."
            },
            {
                "id": "Patient.extension:contactPreference",
                "path": "Patient.extension",
                "sliceName": "contactPreference",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:deathNotificationStatus",
                "path": "Patient.extension",
                "sliceName": "deathNotificationStatus",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:ethnicCategory",
                "path": "Patient.extension",
                "sliceName": "ethnicCategory",
                "short": "The ethnicity of the subject",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:residentialStatus",
                "path": "Patient.extension",
                "sliceName": "residentialStatus",
                "short": "The residential status of the patient.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:patientInterpreterRequired",
                "path": "Patient.extension",
                "sliceName": "patientInterpreterRequired",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:patientInterpreterRequired.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "Indicator showing whether the patient needs an interpreter",
                "definition": "Indicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner."
            },
            {
                "id": "Patient.identifier",
                "path": "Patient.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "Patient.identifier:nhsNumber",
                "path": "Patient.identifier",
                "sliceName": "nhsNumber",
                "short": "The patient's NHS number",
                "max": "1"
            },
            {
                "id": "Patient.identifier:nhsNumber.extension",
                "path": "Patient.identifier.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus",
                "path": "Patient.identifier.extension",
                "sliceName": "nhsNumberVerificationStatus",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.identifier:nhsNumber.system",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "normative"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
                        "valueCode": "4.0.0"
                    }
                ],
                "path": "Patient.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/nhs-number"
            },
            {
                "id": "Patient.identifier:nhsNumber.value",
                "extension":  [
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
                        "valueCode": "normative"
                    },
                    {
                        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
                        "valueCode": "4.0.0"
                    }
                ],
                "path": "Patient.identifier.value",
                "min": 1
            },
            {
                "id": "Patient.identifier:nhsNumber.assigner",
                "path": "Patient.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.telecom.system.extension",
                "path": "Patient.telecom.system.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.telecom.system.extension:otherContactSystem",
                "path": "Patient.telecom.system.extension",
                "sliceName": "otherContactSystem",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.birthDate.extension",
                "path": "Patient.birthDate.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.birthDate.extension:birthTime",
                "path": "Patient.birthDate.extension",
                "sliceName": "birthTime",
                "short": "Time of day of birth.",
                "definition": "The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.birthDate.extension:birthTime.value[x]",
                "path": "Patient.birthDate.extension.value[x]",
                "short": "Time of day of birth.",
                "definition": "The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively."
            },
            {
                "id": "Patient.address",
                "path": "Patient.address",
                "definition": "An address for the individual"
            },
            {
                "id": "Patient.address.extension",
                "path": "Patient.address.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.address.extension:addressKey",
                "path": "Patient.address.extension",
                "sliceName": "addressKey",
                "short": "A patient's address key and type",
                "definition": "A patient's address key and type.",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.maritalStatus",
                "path": "Patient.maritalStatus",
                "binding": {
                    "strength": "extensible",
                    "description": "An indicator to identify the legal marital status of a person",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode"
                }
            },
            {
                "id": "Patient.contact.extension",
                "path": "Patient.contact.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.contact.extension:contactRank",
                "path": "Patient.contact.extension",
                "sliceName": "contactRank",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.contact.extension:copyCorrespondenceIndicator",
                "path": "Patient.contact.extension",
                "sliceName": "copyCorrespondenceIndicator",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.contact.relationship",
                "path": "Patient.contact.relationship",
                "binding": {
                    "strength": "extensible",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType"
                }
            },
            {
                "id": "Patient.contact.telecom.system.extension",
                "path": "Patient.contact.telecom.system.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.contact.telecom.system.extension:otherContactSystem",
                "path": "Patient.contact.telecom.system.extension",
                "sliceName": "otherContactSystem",
                "min": 0,
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.contact.organization",
                "path": "Patient.contact.organization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.contact.organization.identifier.assigner",
                "path": "Patient.contact.organization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.communication.extension",
                "path": "Patient.communication.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.communication.extension:proficiency",
                "path": "Patient.communication.extension",
                "sliceName": "proficiency",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-proficiency"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.communication.extension:proficiency.extension",
                "path": "Patient.communication.extension.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                },
                "min": 0
            },
            {
                "id": "Patient.communication.extension:proficiency.extension:level",
                "path": "Patient.communication.extension.extension",
                "sliceName": "level",
                "min": 0
            },
            {
                "id": "Patient.communication.extension:proficiency.extension:level.value[x]",
                "path": "Patient.communication.extension.extension.value[x]",
                "short": "The proficiency level for the communication",
                "definition": "The proficiency level for the communication."
            },
            {
                "id": "Patient.communication.extension:proficiency.extension:type",
                "path": "Patient.communication.extension.extension",
                "sliceName": "type",
                "min": 0
            },
            {
                "id": "Patient.communication.extension:proficiency.extension:type.value[x]",
                "path": "Patient.communication.extension.extension.value[x]",
                "short": "The proficiency type for the communication",
                "definition": "The proficiency type for the communication."
            },
            {
                "id": "Patient.communication.language",
                "path": "Patient.communication.language",
                "short": "A ValueSet that identifies the language used by a person.",
                "definition": "A ValueSet that identifies the language used by a person.",
                "binding": {
                    "strength": "extensible",
                    "description": "A ValueSet that identifies the language used by a person.",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage"
                }
            },
            {
                "id": "Patient.generalPractitioner",
                "path": "Patient.generalPractitioner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.generalPractitioner.identifier.assigner",
                "path": "Patient.generalPractitioner.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.managingOrganization",
                "path": "Patient.managingOrganization",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.managingOrganization.identifier.assigner",
                "path": "Patient.managingOrganization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.link.other",
                "path": "Patient.link.other",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.link.other.identifier.assigner",
                "path": "Patient.link.other.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Richard Smith - An example to illustrate a male patient's demographics.
Example UKCore-Patient-RichardSmith

Melanie Jones - An example of a baby patient.
Example UKCore-Patient-BabyPatient

Ethnic Category - An example to illustrate patient Ethnic Category information.
Example UKCore-Patient-Extension-EthnicCategory

Address Key - An example to illustrate the use of an address key used with the address datatype.
Example UKCore-Patient-Extension-AddressKey

Birth Sex - An example to illustrate the extension for a patient's birth sex.
Example UKCore-Patient-Extension-BirthSex

Contact Rank - An example to illustrate the extension for the patient's contact ranking.
Example UKCore-Patient-Extension-ContactRank

Contact Preference - An example to illustrate the extension for a patient's contact preferences.
Example UKCore-Patient-Extension-ContactPreference

Copy Correspondence Indicator - An Example to illustrate the extension for copy correspondence indicators.
Example UKCore-Patient-Extension-CopyCorrespondenceIndicator

Death Notification Status - An example to illustrate the extension to indicate the death notification status of the patient.
Example UKCore-Patient-Extension-DeathNotificationStatus

Other Contact System - An example to illustrate the extension to indicate other contact system(s) for a patient Richard Smith.
Example UKCore-Patient-Extension-OtherContactSystem

NHS Number Verification Status - An example of the extension which states the patient's NHS number verification status.
Example UKCore-Patient-Extension-NHSNumberVerificationStatus

Residential Status - An example to illustrate the extension to show the patient's residential status.
Example UKCore-Patient-Extension-ResidentialStatus

Example Usage Scenarios

The following are example usage scenarios for the UK Core Patient profile:

  • Query for Patient demographic information using the query parameter Patient.identifier for a known NHS number.
  • Query for Patient demographic information using query parameters such as Patient.name.family, Patient.name.given, Patient.birthDate, and Patient.gender.
  • Exchange Patient demographic information within a FHIR document or message.

Profile Specific Implementation Guidance:

Minimal Viable Content

A minimum viable content that all provider and consumer systems SHOULD support are the following elements.

Element Reason
Patient.identifier,
Patient.name
As a minimum either a Patient.identifier or Patient.name SHOULD be provided.


Extensions

More information about the extensions can be found using the links below.

Extension Context Link Comment
addressKey Patient.address Extension UKCore-AddressKey
birthPlace Patient Core-defined Extension patient-birthPlace
birthSex Patient Extension UKCore-BirthSex
birthTime Patient.birthDate Core-defined Extension patient-birthTime This SHOULD be included when the birth time is relevant.
cadavericDonor Patient Core-defined Extension patient-cadavericDonor
contactPreference Patient Extension UKCore-ContactPreference
contactRank Patient.contact Extension UKCore-ContactRank
copyCorrespondenceIndicator Patient.contact Extension UKCore-CopyCorrespondenceIndicator
deathNotificationStatus Patient Extension UKCore-DeathNotificationStatus
ethnicCategory Patient Extension UKCore-EthnicCategory
nhsNumberVerificationStatus Patient.identifier:nhsNumber Extension UKCore-NHSNumberVerificationStatus
otherContactSystem Patient.telecom.system Extension UKCore-OtherContactSystem
patientInterpreterRequired Patient Core-defined Extension patient-interpreterRequired
proficiency Patient.communication Core-defined Extension patient-proficiency
residentialStatus Patient Extension UKCore-ResidentialStatus

Bindings (differential)

More information about the bindings to UK Core ValueSets can be found below.

Context Strength Link
Patient.extension:birthSex Required ValueSet UKCore-BirthSex
Patient.extension:contactPreference.extension:
PreferredContactMethod
Extensible ValueSet UKCore-PreferredContactMethod
Patient.extension:contactPreference.extension:
PreferredWrittenCommunicationFormat
Extensible ValueSet UKCore-PreferredWrittenCommunicationFormat
Patient.extension:deathNotificationStatus.extension:
deathNotificationStatus
Extensible ValueSet UKCore-DeathNotificationStatus
Patient.extension:ethnicCategory Preferred ValueSet UKCore-EthnicCategory
Patient.extension:residentialStatus Extensible ValueSet UKCore-ResidentialStatus
Patient.identifer.nhsNumber.extension:
nhsNumberVerificationStatus
Required ValueSet UKCore-NHSNumberVerificationStatus
Patient.address.extension:
addressKey.extension:type
Extensible ValueSet UKCore-AddressKeyType
Patient.maritalStatus Extensible ValueSet UKCore-PersonMaritalStatusCode
Patient.contact.relationship Extensible ValueSet UKCore-PersonRelationshipType
Patient.communication.language Extensible ValueSet UKCore-HumanLanguage

identifier

In England and Wales this SHOULD include the patient's NHS number, where this is not possible then a Medical Records Number (MRN) MAY be used.

If the identifier is an NHS number then the extension Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus SHOULD be populated to indicate the verification status with a code from the ValueSet UKCore-NHSNumberVerificationStatus.


name

The patient name represented by the HumanName data type.

Multiple names can be included.


telecom

A contact detail (e.g. a telephone number or an email address) by which the patient may be contacted.

Telecom uses the ContactPoint data type.


address

The address of the patient using the Address datatype.

A patient may have multiple addresses with different uses or applicable periods.


photo

A photograph relating to a patient. This can be included as either:

  • An attachment encoded as base64Binary with a relevant MIME contentType: image/png, image/jpg or image/jpeg preferred.

Example of Patient.photo usage:

Table View

Patient.id[0]UKCore-Patient-Sn-Photo-Example
Patient.photo[0].contentType[0]image/png
Patient.photo[0].data[0]base64Binary

Tree View

Patient

XML View

<Patient xmlns="http://hl7.org/fhir">
    <id value="UKCore-Patient-Sn-Photo-Example" />
    <!--  **************snippet start**************  -->
    <photo>
        <contentType value="image/png" />
        <data value="base64Binary" />
    </photo>
    <!--  **************snippet end**************  -->
</Patient>

JSON View

{
    "resourceType": "Patient",
    "id": "UKCore-Patient-Sn-Photo-Example",
    "photo":  [
        {
            "contentType": "image/png",
            "data": "base64Binary"
        }
    ]
}

and/or
  • URL where the data can be found.

If both are used, the URL SHALL point to the same data as that encoded in the attachment.


communication

One or more instances of this element can be used to list the languages the patient is able to communicate in.

Use the value set below. One of these instances SHOULD be marked as preferred.

ValueSet UKCore-HumanLanguage.


managingOrganization

An Organization that is the custodian of the patient record (such as a general practice).

The Patient.managingOrganization may change according to the setting (a mental health record may be managed by a MH trust), whereas the Patient.generalPractitioner points to your GP or GP Practice.


generalPractitioner

The patient's GP by reference to Practitioner which SHOULD conform to Profile UKCore-Practitioner for the GP and/or Profile UKCore-Organization for the patient's GP practice.

The resource being referenced SHOULD conform to one of the stated profiles.


back to top