HL7 UK - UK Core Access
0.1.0 - ci-build
HL7 UK - UK Core Access, published by HL7 UK. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-UK/UK-Core-Access/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient | Version: 0.1.0 | |||
Active as of 2022-08-26 | Computable Name: UKCorePatient | |||
Copyright/Legal: 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. |
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.
This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthPlace | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
value[x] | 1..1 | Address | The registered place of birth of the patient. | |
birthSex | 0..1 | code | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | |
cadavericDonor | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
value[x] | 1..1 | boolean | Post-mortem donor status. | |
contactPreference | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | |
deathNotificationStatus | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | |
ethnicCategory | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (preferred): A set of codes that define the ethnicity of a person, as specified by the person. | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible) | |
patientInterpreterRequired | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
value[x] | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | |
identifier:nhsNumber | 0..1 | Identifier | The patient's NHS number | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nhsNumberVerificationStatus | 0..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) | |
system | N | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | N | 1..1 | string | The value that is unique |
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
telecom | ||||
system | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
value[x] | 1..1 | dateTime | Time of day of birth. | |
address | 0..* | Address | An address for the individual | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
addressKey | 0..* | (Complex) | A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person | |
contact | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactRank | 0..1 | positiveInt | Preferred ranking or order of contact applied to a contact on a patient's contact list URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank | |
copyCorrespondenceIndicator | 0..1 | boolean | Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator | |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: UK Core Person Relationship Type (extensible) | |
telecom | ||||
system | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |
organization | 0..1 | Reference(UK Core Organization) | Organization that is associated with the contact | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
communication | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
proficiency | 0..1 | (Complex) | Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:level | 0..1 | Extension | Extension | |
value[x] | 1..1 | Coding | The proficiency level for the communication | |
extension:type | 0..* | Extension | Extension | |
value[x] | 1..1 | Coding | The proficiency type for the communication | |
language | 1..1 | CodeableConcept | A ValueSet that identifies the language used by a person. Binding: UK Core Human Language (extensible): A ValueSet that identifies the language used by a person. | |
generalPractitioner | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
managingOrganization | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
link | ||||
other | 1..1 | Reference(UK Core Patient(2.2.0) | UK Core RelatedPerson) | The other patient or related person resource that the link refers to | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.maritalStatus | extensible | UKCorePersonMaritalStatusCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode | |
Patient.contact.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | |
Patient.communication.language | extensible | UKCoreHumanLanguagehttps://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthPlace | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | 1..1 | Address | The registered place of birth of the patient. | |
birthSex | 0..1 | code | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | |
cadavericDonor | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |
value[x] | 1..1 | boolean | Post-mortem donor status. | |
contactPreference | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | |
deathNotificationStatus | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | |
ethnicCategory | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (preferred): A set of codes that define the ethnicity of a person, as specified by the person. | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible) | |
patientInterpreterRequired | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |
value[x] | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nhsNumberVerificationStatus | 0..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | Σ | 0..* | Address | An address for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
addressKey | 0..* | (Complex) | A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person | |
generalPractitioner | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(UK Core Patient(2.2.0) | UK Core RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.identifier:nhsNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.maritalStatus | extensible | UKCorePersonMaritalStatusCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
birthPlace | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | 1..1 | Address | The registered place of birth of the patient. | |||||
birthSex | 0..1 | code | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | |||||
cadavericDonor | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |||||
value[x] | 1..1 | boolean | Post-mortem donor status. | |||||
contactPreference | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | |||||
deathNotificationStatus | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | |||||
ethnicCategory | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (preferred): A set of codes that define the ethnicity of a person, as specified by the person. | |||||
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible) | |||||
patientInterpreterRequired | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |||||
value[x] | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nhsNumberVerificationStatus | 0..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | Σ | 0..* | HumanName | A name associated with the patient | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |||||
value | 0..1 | string | Primitive value for code | |||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
birthTime | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |||||
value[x] | 1..1 | dateTime | Time of day of birth. | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | Σ | 0..* | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
addressKey | 0..* | (Complex) | A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
contactRank | 0..1 | positiveInt | Preferred ranking or order of contact applied to a contact on a patient's contact list URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank | |||||
copyCorrespondenceIndicator | 0..1 | boolean | Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: UK Core Person Relationship Type (extensible) | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |||||
value | 0..1 | string | Primitive value for code | |||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(UK Core Organization) | Organization that is associated with the contact | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
proficiency | 0..1 | (Complex) | Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:level | 0..1 | Extension | Extension | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "level" | |||||
value[x] | 1..1 | Coding | The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication. | |||||
extension:type | 0..* | Extension | Extension | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "type" | |||||
value[x] | 1..1 | Coding | The proficiency type for the communication Binding: LanguageAbilityMode (preferred): The proficiency type for the communication. | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-proficiency" | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | A ValueSet that identifies the language used by a person. Binding: UK Core Human Language (extensible): A ValueSet that identifies the language used by a person. | |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
managingOrganization | Σ | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(UK Core Patient(2.2.0) | UK Core RelatedPerson) | The other patient or related person resource that the link refers to | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:nhsNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:nhsNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | UKCorePersonMaritalStatusCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode | ||||
Patient.contact.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | ||||
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.contact.organization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.contact.organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.communication.extension:proficiency.extension:level.value[x] | preferred | LanguageAbilityProficiencyhttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency | ||||
Patient.communication.extension:proficiency.extension:type.value[x] | preferred | LanguageAbilityModehttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode | ||||
Patient.communication.language | extensible | UKCoreHumanLanguagehttps://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage | ||||
Patient.generalPractitioner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.generalPractitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.generalPractitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.managingOrganization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.managingOrganization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.link.other.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.link.other.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.link.other.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthPlace | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
value[x] | 1..1 | Address | The registered place of birth of the patient. | |
birthSex | 0..1 | code | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | |
cadavericDonor | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
value[x] | 1..1 | boolean | Post-mortem donor status. | |
contactPreference | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | |
deathNotificationStatus | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | |
ethnicCategory | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (preferred): A set of codes that define the ethnicity of a person, as specified by the person. | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible) | |
patientInterpreterRequired | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
value[x] | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | |
identifier:nhsNumber | 0..1 | Identifier | The patient's NHS number | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nhsNumberVerificationStatus | 0..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) | |
system | N | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | N | 1..1 | string | The value that is unique |
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
telecom | ||||
system | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthTime | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
value[x] | 1..1 | dateTime | Time of day of birth. | |
address | 0..* | Address | An address for the individual | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
addressKey | 0..* | (Complex) | A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person | |
contact | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
contactRank | 0..1 | positiveInt | Preferred ranking or order of contact applied to a contact on a patient's contact list URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank | |
copyCorrespondenceIndicator | 0..1 | boolean | Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator | |
relationship | 0..* | CodeableConcept | The kind of relationship Binding: UK Core Person Relationship Type (extensible) | |
telecom | ||||
system | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |
organization | 0..1 | Reference(UK Core Organization) | Organization that is associated with the contact | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
communication | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
proficiency | 0..1 | (Complex) | Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
extension:level | 0..1 | Extension | Extension | |
value[x] | 1..1 | Coding | The proficiency level for the communication | |
extension:type | 0..* | Extension | Extension | |
value[x] | 1..1 | Coding | The proficiency type for the communication | |
language | 1..1 | CodeableConcept | A ValueSet that identifies the language used by a person. Binding: UK Core Human Language (extensible): A ValueSet that identifies the language used by a person. | |
generalPractitioner | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
managingOrganization | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
link | ||||
other | 1..1 | Reference(UK Core Patient(2.2.0) | UK Core RelatedPerson) | The other patient or related person resource that the link refers to | |
identifier | ||||
assigner | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.maritalStatus | extensible | UKCorePersonMaritalStatusCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode | |
Patient.contact.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | |
Patient.communication.language | extensible | UKCoreHumanLanguagehttps://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
birthPlace | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | 1..1 | Address | The registered place of birth of the patient. | |
birthSex | 0..1 | code | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | |
cadavericDonor | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |
value[x] | 1..1 | boolean | Post-mortem donor status. | |
contactPreference | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | |
deathNotificationStatus | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | |
ethnicCategory | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (preferred): A set of codes that define the ethnicity of a person, as specified by the person. | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible) | |
patientInterpreterRequired | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |
value[x] | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
nhsNumberVerificationStatus | 0..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | Σ | 0..* | Address | An address for the individual |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
addressKey | 0..* | (Complex) | A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person | |
generalPractitioner | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider | |
managingOrganization | Σ | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(UK Core Patient(2.2.0) | UK Core RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Patient.identifier:nhsNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Patient.maritalStatus | extensible | UKCorePersonMaritalStatusCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode | |
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
birthPlace | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | 1..1 | Address | The registered place of birth of the patient. | |||||
birthSex | 0..1 | code | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | |||||
cadavericDonor | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |||||
value[x] | 1..1 | boolean | Post-mortem donor status. | |||||
contactPreference | 0..1 | (Complex) | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference | |||||
deathNotificationStatus | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | |||||
ethnicCategory | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (preferred): A set of codes that define the ethnicity of a person, as specified by the person. | |||||
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible) | |||||
patientInterpreterRequired | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |||||
value[x] | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nhsNumberVerificationStatus | 0..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | Σ | 0..* | HumanName | A name associated with the patient | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |||||
value | 0..1 | string | Primitive value for code | |||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
birthTime | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |||||
value[x] | 1..1 | dateTime | Time of day of birth. | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | Σ | 0..* | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
addressKey | 0..* | (Complex) | A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person | |||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient pat-1: SHALL at least contain a contact's details or a reference to an organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
contactRank | 0..1 | positiveInt | Preferred ranking or order of contact applied to a contact on a patient's contact list URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank | |||||
copyCorrespondenceIndicator | 0..1 | boolean | Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: UK Core Person Relationship Type (extensible) | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
otherContactSystem | 0..1 | Coding | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | |||||
value | 0..1 | string | Primitive value for code | |||||
value | Σ | 0..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
address | 0..1 | Address | Address for the contact person | |||||
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
organization | C | 0..1 | Reference(UK Core Organization) | Organization that is associated with the contact | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
proficiency | 0..1 | (Complex) | Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:level | 0..1 | Extension | Extension | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "level" | |||||
value[x] | 1..1 | Coding | The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication. | |||||
extension:type | 0..* | Extension | Extension | |||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "type" | |||||
value[x] | 1..1 | Coding | The proficiency type for the communication Binding: LanguageAbilityMode (preferred): The proficiency type for the communication. | |||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-proficiency" | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
language | 1..1 | CodeableConcept | A ValueSet that identifies the language used by a person. Binding: UK Core Human Language (extensible): A ValueSet that identifies the language used by a person. | |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
managingOrganization | Σ | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | Σ | 1..1 | Reference(UK Core Patient(2.2.0) | UK Core RelatedPerson) | The other patient or related person resource that the link refers to | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Patient.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Patient.identifier:nhsNumber.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.identifier:nhsNumber.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Patient.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Patient.maritalStatus | extensible | UKCorePersonMaritalStatusCodehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode | ||||
Patient.contact.relationship | extensible | UKCorePersonRelationshipTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType | ||||
Patient.contact.telecom.system | required | ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
Patient.contact.telecom.use | required | ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
Patient.contact.organization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.contact.organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.contact.organization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.communication.extension:proficiency.extension:level.value[x] | preferred | LanguageAbilityProficiencyhttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency | ||||
Patient.communication.extension:proficiency.extension:type.value[x] | preferred | LanguageAbilityModehttp://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode | ||||
Patient.communication.language | extensible | UKCoreHumanLanguagehttps://fhir.hl7.org.uk/ValueSet/UKCore-HumanLanguage | ||||
Patient.generalPractitioner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.generalPractitioner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.generalPractitioner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.managingOrganization.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.managingOrganization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.managingOrganization.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.link.other.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Patient.link.other.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Patient.link.other.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron