HL7 FHIR® UK Core
4.0.0 - CI Build
HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions
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.
The official URL for this profile is:
https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Patient
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | ΣI | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() | ?!I | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ΣI | 0..* | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | The patient's NHS number |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | I | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) |
![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
![]() ![]() ![]() ![]() ![]() | ΣI | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | ΣI | 0..* | HumanName | A name associated with the patient |
![]() ![]() ![]() | ΣI | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | ΣI | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!ΣI | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | ΣI | 0..* | Address | An address for the individual |
![]() ![]() ![]() | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() | I | 0..1 | Whether patient is part of a multiple birth | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() | I | 0..* | Attachment | Image of the patient |
![]() ![]() ![]() | I | 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 |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | I | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) |
![]() ![]() ![]() ![]() | I | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | I | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(UK Core Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() ![]() | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
![]() ![]() ![]() | I | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
![]() ![]() ![]() ![]() | I | 0..1 | boolean | Language preference indicator |
![]() ![]() ![]() | I | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Reference(UK Core Patient | UK Core RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
![]() |
This structure is derived from Patient
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 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
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Patient | Information about an individual or animal receiving health care services |
![]() ![]() ![]() | Σ | 0..1 | string | Logical id of this artifact |
![]() ![]() ![]() | ΣI | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
![]() ![]() ![]() | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() | ?!I | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | ΣI | 0..* | (Slice Definition) | An identifier for this patient Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | The patient's NHS number |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | I | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.nhs.uk/R4/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) |
![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
![]() ![]() ![]() ![]() ![]() | ΣI | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!ΣI | 0..1 | boolean | Whether this patient's record is in active use |
![]() ![]() ![]() | ΣI | 0..* | HumanName | A name associated with the patient |
![]() ![]() ![]() | ΣI | 0..* | ContactPoint | A contact detail for the individual |
![]() ![]() ![]() | ΣI | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() | ΣI | 0..1 | date | The date of birth for the individual |
![]() ![]() ![]() | ?!ΣI | 0..1 | Indicates if the individual is deceased or not | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | dateTime | |||
![]() ![]() ![]() | ΣI | 0..* | Address | An address for the individual |
![]() ![]() ![]() | I | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible) |
![]() ![]() ![]() | I | 0..1 | Whether patient is part of a multiple birth | |
![]() ![]() ![]() ![]() | boolean | |||
![]() ![]() ![]() ![]() | integer | |||
![]() ![]() ![]() | I | 0..* | Attachment | Image of the patient |
![]() ![]() ![]() | I | 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 |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | I | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible) |
![]() ![]() ![]() ![]() | I | 0..1 | HumanName | A name associated with the contact person |
![]() ![]() ![]() ![]() | I | 0..* | ContactPoint | A contact detail for the person |
![]() ![]() ![]() ![]() | I | 0..1 | Address | Address for the contact person |
![]() ![]() ![]() ![]() | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
![]() ![]() ![]() ![]() | I | 0..1 | Reference(UK Core Organization) | Organization that is associated with the contact |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() ![]() | I | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
![]() ![]() ![]() | I | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | I | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
![]() ![]() ![]() ![]() | I | 0..1 | boolean | Language preference indicator |
![]() ![]() ![]() | I | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Patient's nominated primary care provider |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that is the custodian of the patient record |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() | ?!ΣI | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations |
![]() ![]() ![]() ![]() | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | ΣI | 1..1 | Reference(UK Core Patient | UK Core RelatedPerson) | The other patient or related person resource that the link refers to |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
![]() ![]() ![]() ![]() ![]() ![]() | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() ![]() ![]() | ΣI | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required) |
![]() |
Other representations of profile: Schematron
Path | Conformance | ValueSet |
Patient.language | preferred | CommonLanguages Max Binding: AllLanguages |
Patient.identifier:nhsNumber.use | required | IdentifierUse |
Patient.identifier:nhsNumber.type | extensible | Identifier Type Codes |
Patient.gender | required | AdministrativeGender |
Patient.maritalStatus | extensible | Marital Status Codes |
Patient.contact.relationship | extensible | PatientContactRelationship |
Patient.contact.gender | required | AdministrativeGender |
Patient.contact.organization.type | extensible | ResourceType |
Patient.contact.organization.identifier.use | required | IdentifierUse |
Patient.contact.organization.identifier.type | extensible | Identifier Type Codes |
Patient.communication.language | preferred | CommonLanguages Max Binding: AllLanguages |
Patient.generalPractitioner.type | extensible | ResourceType |
Patient.generalPractitioner.identifier.use | required | IdentifierUse |
Patient.generalPractitioner.identifier.type | extensible | Identifier Type Codes |
Patient.managingOrganization.type | extensible | ResourceType |
Patient.managingOrganization.identifier.use | required | IdentifierUse |
Patient.managingOrganization.identifier.type | extensible | Identifier Type Codes |
Patient.link.other.type | extensible | ResourceType |
Patient.link.other.identifier.use | required | IdentifierUse |
Patient.link.other.identifier.type | extensible | Identifier Type Codes |
Patient.link.type | required | LinkType |
Id | Path | Details | Requirements |
dom-2 | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Patient | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Patient | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Patient.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.identifier:nhsNumber.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.identifier:nhsNumber.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.identifier:nhsNumber.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.deceased[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.maritalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.multipleBirth[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
pat-1 | 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() | |
ele-1 | Patient.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.contact.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.contact.organization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.contact.organization.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.contact.organization.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.contact.organization.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.organization.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.contact.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.generalPractitioner.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.generalPractitioner.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.generalPractitioner.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.generalPractitioner.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.generalPractitioner.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.managingOrganization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.managingOrganization.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.managingOrganization.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.managingOrganization.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.managingOrganization.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.link.other | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.link.other.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.link.other.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Patient.link.other.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Patient.link.other.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.other.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Patient.link.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |