UK Core Implementation Guide 0.1.0 STU1

StructureDefinition-UKCore-Patient

Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information.

Profile Purpose

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
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueBooleanboolean
nhsNumberVerificationStatusI1..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
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueBooleanboolean
nhsNumberVerificationStatusI1..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
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueBooleanboolean
nhsNumberVerificationStatusI1..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.extension..
Patient.extensionExtension..
Patient.extension.value[x]..
Patient.extensionExtension..
Patient.extensionExtension..
Patient.extension.value[x]..
Patient.extensionExtension..
Patient.extensionExtension..
Patient.extensionExtension0..1
Patient.extensionExtension..
Patient.extensionExtension0..1
Patient.extension.value[x]..
Patient.extensionExtension0..1
Patient.extension.value[x]..
Patient.identifier..
Patient.identifier..1
Patient.identifier.extension..
Patient.identifier.extensionExtension1..1
Patient.identifier.system1..
Patient.identifier.value1..
Patient.identifier.assignerReference(UK Core Organization)..
Patient.telecom..
Patient.telecom.system..
Patient.telecom.system.extension..
Patient.telecom.system.extensionExtension0..1
Patient.birthDate..
Patient.birthDate.extension..
Patient.birthDate.extensionExtension..
Patient.birthDate.extension.value[x]..
Patient.address..
Patient.address.extension..
Patient.address.extensionExtension0..*
Patient.maritalStatus..
Patient.contact..
Patient.contact.extension..
Patient.contact.extensionExtension..
Patient.contact.extensionExtension..
Patient.contact.relationship..
Patient.contact.telecom..
Patient.contact.telecom.system..
Patient.contact.telecom.system.extension..
Patient.contact.telecom.system.extensionExtension0..1
Patient.contact.organizationReference(UK Core Organization)..
Patient.contact.organization.identifier..
Patient.contact.organization.identifier.assignerReference(UK Core Organization)..
Patient.communication..
Patient.communication.extension..
Patient.communication.extensionExtension0..1
Patient.communication.extension.extension..
Patient.communication.extension.extension..
Patient.communication.extension.extension.value[x]..
Patient.communication.extension.extension..
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.1.0" />
    <name value="UKCorePatient" />
    <title value="UK Core Patient" />
    <status value="active" />
    <date value="2021-09-10" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information." />
    <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>
        </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." />
            <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." />
            <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." />
            <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" />
            <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" />
            <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" />
            <definition 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." />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" />
            </type>
        </element>
        <element id="Patient.extension:patientReligion">
            <path value="Patient.extension" />
            <sliceName value="patientReligion" />
            <short value="The patient&#39;s professed religious affiliations" />
            <definition value="The patient&#39;s professed religious affiliations." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/patient-religion" />
            </type>
        </element>
        <element id="Patient.extension:patientReligion.value[x]">
            <path value="Patient.extension.value[x]" />
            <short value="The religious affiliation of the patient" />
            <definition value="The religious affiliation of the patient." />
        </element>
        <element id="Patient.extension:patientInterpreterRequired">
            <path value="Patient.extension" />
            <sliceName value="patientInterpreterRequired" />
            <short value="Whether the patient needs an interpreter" />
            <definition value="This Patient requires an interpreter to communicate healthcare information to the practitioner." />
            <min value="0" />
            <max value="1" />
            <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>
        </element>
        <element id="Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus">
            <path value="Patient.identifier.extension" />
            <sliceName value="nhsNumberVerificationStatus" />
            <min value="1" />
            <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>
        </element>
        <element id="Patient.telecom.system.extension:otherContactSystem">
            <path value="Patient.telecom.system.extension" />
            <sliceName value="otherContactSystem" />
            <short value="Other contact system" />
            <definition value="Other contact system value which extends the system element in the ContactPoint datatype." />
            <min value="0" />
            <max value="1" />
            <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>
        </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." />
            <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>
        </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" />
            <max value="*" />
            <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>
        </element>
        <element id="Patient.contact.extension:contactRank">
            <path value="Patient.contact.extension" />
            <sliceName value="contactRank" />
            <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" />
            <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>
        </element>
        <element id="Patient.contact.telecom.system.extension:otherContactSystem">
            <path value="Patient.contact.telecom.system.extension" />
            <sliceName value="otherContactSystem" />
            <short value="Other contact system" />
            <definition value="Other contact system value which extends the system element in the ContactPoint datatype." />
            <min value="0" />
            <max value="1" />
            <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>
        </element>
        <element id="Patient.communication.extension:proficiency">
            <path value="Patient.communication.extension" />
            <sliceName value="proficiency" />
            <short value="Proficiency level of the communication" />
            <definition value="Proficiency level of the communication." />
            <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>
        </element>
        <element id="Patient.communication.extension:proficiency.extension:level">
            <path value="Patient.communication.extension.extension" />
            <sliceName value="level" />
        </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" />
        </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.1.0",
    "name": "UKCorePatient",
    "title": "UK Core Patient",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information.",
    "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"
                }
            },
            {
                "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.",
                "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.",
                "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.",
                "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",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:deathNotificationStatus",
                "path": "Patient.extension",
                "sliceName": "deathNotificationStatus",
                "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",
                "definition": "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.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:patientReligion",
                "path": "Patient.extension",
                "sliceName": "patientReligion",
                "short": "The patient's professed religious affiliations",
                "definition": "The patient's professed religious affiliations.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/patient-religion"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.extension:patientReligion.value[x]",
                "path": "Patient.extension.value[x]",
                "short": "The religious affiliation of the patient",
                "definition": "The religious affiliation of the patient."
            },
            {
                "id": "Patient.extension:patientInterpreterRequired",
                "path": "Patient.extension",
                "sliceName": "patientInterpreterRequired",
                "short": "Whether the patient needs an interpreter",
                "definition": "This Patient requires an interpreter to communicate healthcare information to the practitioner.",
                "min": 0,
                "max": "1",
                "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"
                }
            },
            {
                "id": "Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus",
                "path": "Patient.identifier.extension",
                "sliceName": "nhsNumberVerificationStatus",
                "min": 1,
                "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"
                }
            },
            {
                "id": "Patient.telecom.system.extension:otherContactSystem",
                "path": "Patient.telecom.system.extension",
                "sliceName": "otherContactSystem",
                "short": "Other contact system",
                "definition": "Other contact system value which extends the system element in the ContactPoint datatype.",
                "min": 0,
                "max": "1",
                "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"
                }
            },
            {
                "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.",
                "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"
                }
            },
            {
                "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,
                "max": "*",
                "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"
                }
            },
            {
                "id": "Patient.contact.extension:contactRank",
                "path": "Patient.contact.extension",
                "sliceName": "contactRank",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank"
                        ]
                    }
                ]
            },
            {
                "id": "Patient.contact.extension:copyCorrespondenceIndicator",
                "path": "Patient.contact.extension",
                "sliceName": "copyCorrespondenceIndicator",
                "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"
                }
            },
            {
                "id": "Patient.contact.telecom.system.extension:otherContactSystem",
                "path": "Patient.contact.telecom.system.extension",
                "sliceName": "otherContactSystem",
                "short": "Other contact system",
                "definition": "Other contact system value which extends the system element in the ContactPoint datatype.",
                "min": 0,
                "max": "1",
                "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"
                }
            },
            {
                "id": "Patient.communication.extension:proficiency",
                "path": "Patient.communication.extension",
                "sliceName": "proficiency",
                "short": "Proficiency level of the communication",
                "definition": "Proficiency level of the communication.",
                "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"
                }
            },
            {
                "id": "Patient.communication.extension:proficiency.extension:level",
                "path": "Patient.communication.extension.extension",
                "sliceName": "level"
            },
            {
                "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"
            },
            {
                "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
Richard Smith - An example to illustrate patient Ethnic Category information.
Example UKCore-Patient-EthnicCategory

Example Usage Scenarios

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

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

Profile specific implementation guidance:

Minimal Viable Content

As a minimum either a patient.identifier or patient.name should be provided.

All other elements are optional.


extension:patient-birthPlace

More information about this extension can be found using the link below.

Common Extension patient-birthPlace.


extension:birthSex

More information about this extension can be found using the link below.

Extension UKCore-BirthSex.


extension:cadavericDonor

More information about this extension can be found using the link below.

Common Extension patient-cadavericDonor.


extension:contactPreference

More information about this extension can be found using the link below.

Extension UKCore-ContactPreference.


extension:deathNotificationStatus

More information about this extension can be found using the link below.

Extension UKCore-DeathNotificationStatus


extension:ethnicCategory

More information about this extension can be found using the link below.

Extension UKCore-EthnicCategory


residentialStatus

More information about this extension can be found using the link below.

Extension UKCore-ResidentialStatus.


extension:patientReligion

More information about this extension can be found using the link below.

Common Extension patient-religion.

extension:patientInterpreterRequired

More information about this extension can be found using the link below.

Common Extension patient-InterpreterRequired.


identifier

In England this should include the patient's NHS number, additional identifiers can also be added.

The extension Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus should be populated to indicate the verification status of the NHS number with a code from the ValueSet UKCoreNHSNumberVerificationStatus.


active

A boolean value indicating if the patient's record is in current use.

Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organisation's business rules.

It can also be use to mark a duplicate record created in error with the link element pointing to the active record.


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.


gender

Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.

HTML View

This code system http://hl7.org/fhir/administrative-gender defines the following codes:

CodeDisplayDefinition
maleMaleMale.
femaleFemaleFemale.
otherOtherOther.
unknownUnknownUnknown.

Table View

CodeSystem.id[0]administrative-gender
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].valueCode[0]4.0.0
CodeSystem.url[0]http://hl7.org/fhir/administrative-gender
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.2
CodeSystem.version[0]4.0.1
CodeSystem.name[0]AdministrativeGender
CodeSystem.title[0]AdministrativeGender
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.description[0]The gender of a person used for administrative purposes.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/administrative-gender
CodeSystem.content[0]complete
CodeSystem.concept[0].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[0].extension[0].valueString[0]Male
CodeSystem.concept[0].code[0]male
CodeSystem.concept[0].display[0]Male
CodeSystem.concept[0].definition[0]Male.
CodeSystem.concept[1].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[1].extension[0].valueString[0]Female
CodeSystem.concept[1].code[0]female
CodeSystem.concept[1].display[0]Female
CodeSystem.concept[1].definition[0]Female.
CodeSystem.concept[2].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[2].extension[0].valueString[0]The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value.
CodeSystem.concept[2].code[0]other
CodeSystem.concept[2].display[0]Other
CodeSystem.concept[2].definition[0]Other.
CodeSystem.concept[3].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[3].extension[0].valueString[0]A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
CodeSystem.concept[3].code[0]unknown
CodeSystem.concept[3].display[0]Unknown
CodeSystem.concept[3].definition[0]Unknown.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="administrative-gender" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <url value="http://hl7.org/fhir/administrative-gender" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.2" />
    </identifier>
    <version value="4.0.1" />
    <name value="AdministrativeGender" />
    <title value="AdministrativeGender" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <description value="The gender of a person used for administrative purposes." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" />
    <content value="complete" />
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Male" />
        </extension>
        <code value="male" />
        <display value="Male" />
        <definition value="Male." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Female" />
        </extension>
        <code value="female" />
        <display value="Female" />
        <definition value="Female." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." />
        </extension>
        <code value="other" />
        <display value="Other" />
        <definition value="Other." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of &quot;unknown&quot;. (E.g. a local code sent as a translation that conveys &#39;unknown&#39;) Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to convey that it is the home phone number that is unknown.)" />
        </extension>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="Unknown." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "administrative-gender",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        }
    ],
    "url": "http://hl7.org/fhir/administrative-gender",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.2"
        }
    ],
    "version": "4.0.1",
    "name": "AdministrativeGender",
    "title": "AdministrativeGender",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "description": "The gender of a person used for administrative purposes.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender",
    "content": "complete",
    "concept":  [
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Male"
                }
            ],
            "code": "male",
            "display": "Male",
            "definition": "Male."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Female"
                }
            ],
            "code": "female",
            "display": "Female",
            "definition": "Female."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value."
                }
            ],
            "code": "other",
            "display": "Other",
            "definition": "Other."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of \"unknown\". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of \"H\" and a URL prefix of \"tel:\" to convey that it is the home phone number that is unknown.)"
                }
            ],
            "code": "unknown",
            "display": "Unknown",
            "definition": "Unknown."
        }
    ]
}

birthDate

The patient's date of birth. An approximate date may be used (e.g. just the year) where the full date is not known.

birthDate includes an extension Common Extension patient-birthTime This should be included when the birth time is relevant.


deceased

Either:

A boolean value indicating the patient is dead

or

The DateTime of death

Where the patient is alive sending systems can omit this element, it is not necessary to include it to indicate that the patient is not dead.

Where this element is missing, receiving systems can assume the patient is alive.


address

The address of the patient using the Address datatype.

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


maritalStatus

HTML View

This code system http://hl7.org/fhir/administrative-gender defines the following codes:

CodeDisplayDefinition
maleMaleMale.
femaleFemaleFemale.
otherOtherOther.
unknownUnknownUnknown.

Table View

CodeSystem.id[0]administrative-gender
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]normative
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]5
CodeSystem.extension[3].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version
CodeSystem.extension[3].valueCode[0]4.0.0
CodeSystem.url[0]http://hl7.org/fhir/administrative-gender
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.2
CodeSystem.version[0]4.0.1
CodeSystem.name[0]AdministrativeGender
CodeSystem.title[0]AdministrativeGender
CodeSystem.status[0]active
CodeSystem.experimental[0]False
CodeSystem.date[0]2019-11-01T09:29:23+11:00
CodeSystem.description[0]The gender of a person used for administrative purposes.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/administrative-gender
CodeSystem.content[0]complete
CodeSystem.concept[0].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[0].extension[0].valueString[0]Male
CodeSystem.concept[0].code[0]male
CodeSystem.concept[0].display[0]Male
CodeSystem.concept[0].definition[0]Male.
CodeSystem.concept[1].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[1].extension[0].valueString[0]Female
CodeSystem.concept[1].code[0]female
CodeSystem.concept[1].display[0]Female
CodeSystem.concept[1].definition[0]Female.
CodeSystem.concept[2].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[2].extension[0].valueString[0]The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value.
CodeSystem.concept[2].code[0]other
CodeSystem.concept[2].display[0]Other
CodeSystem.concept[2].definition[0]Other.
CodeSystem.concept[3].extension[0].url[0]http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments
CodeSystem.concept[3].extension[0].valueString[0]A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)
CodeSystem.concept[3].code[0]unknown
CodeSystem.concept[3].display[0]Unknown
CodeSystem.concept[3].definition[0]Unknown.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="administrative-gender" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="normative" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="5" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
        <valueCode value="4.0.0" />
    </extension>
    <url value="http://hl7.org/fhir/administrative-gender" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.2" />
    </identifier>
    <version value="4.0.1" />
    <name value="AdministrativeGender" />
    <title value="AdministrativeGender" />
    <status value="active" />
    <experimental value="false" />
    <date value="2019-11-01T09:29:23+11:00" />
    <description value="The gender of a person used for administrative purposes." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" />
    <content value="complete" />
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Male" />
        </extension>
        <code value="male" />
        <display value="Male" />
        <definition value="Male." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="Female" />
        </extension>
        <code value="female" />
        <display value="Female" />
        <definition value="Female." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." />
        </extension>
        <code value="other" />
        <display value="Other" />
        <definition value="Other." />
    </concept>
    <concept>
        <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments">
            <valueString value="A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of &quot;unknown&quot;. (E.g. a local code sent as a translation that conveys &#39;unknown&#39;) Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of &quot;H&quot; and a URL prefix of &quot;tel:&quot; to convey that it is the home phone number that is unknown.)" />
        </extension>
        <code value="unknown" />
        <display value="Unknown" />
        <definition value="Unknown." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "administrative-gender",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00"
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "normative"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 5
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
            "valueCode": "4.0.0"
        }
    ],
    "url": "http://hl7.org/fhir/administrative-gender",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.2"
        }
    ],
    "version": "4.0.1",
    "name": "AdministrativeGender",
    "title": "AdministrativeGender",
    "status": "active",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "description": "The gender of a person used for administrative purposes.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender",
    "content": "complete",
    "concept":  [
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Male"
                }
            ],
            "code": "male",
            "display": "Male",
            "definition": "Male."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "Female"
                }
            ],
            "code": "female",
            "display": "Female",
            "definition": "Female."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value."
                }
            ],
            "code": "other",
            "display": "Other",
            "definition": "Other."
        },
        {
            "extension":  [
                {
                    "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments",
                    "valueString": "A proper value is applicable, but not known.  Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless:  Those properties themselves directly translate to a semantic of \"unknown\". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of \"H\" and a URL prefix of \"tel:\" to convey that it is the home phone number that is unknown.)"
                }
            ],
            "code": "unknown",
            "display": "Unknown",
            "definition": "Unknown."
        }
    ]
}


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.

e.g. JSON

"photo": [
    {
      "contentType": "image/png",
      "data":"{base64Binary} "
    }
]

and/or

  • URL where the data can be found.

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


contact

A contact relevant to the care of the patient and may include family members, business contacts, guardians, caregivers, etc.

contact should not be used to represent family genealogy.


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.

CodeSystem UKCoreHumanLanguage.


generalPractitioner

The patient's GP by reference to UKCore-Organization for the GP and/or UKCore-Organization for the patient's GP practice.


managingOrganization

Organisation that is the custodian of the patient record.

This is a reference to the "Organisation that is the custodian of the patient record" (such as a general practice).

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


back to top