Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.virtually.healthcare/StructureDefinition/Patient | Version: 0.1.0-current | |||
Draft as of 2024-11-06 | Computable Name: Patient |
Extension of UKCore-Patient and includes elements from HL7 International Access
TODO
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | UKCorePatient | |||
identifier | 1..* | Identifier | An identifier for this patient | |
Slices for identifier | Content/Rules for all slices | |||
identifier:nhsNumber | 0..1 | NHSNumbers | UK National Health Identifiers | |
identifier:MedicalRecordNumber | 0..* | MedicalRecordNumber | Medical Record Number | |
name | 1..* | HumanName | A name associated with the patient | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | UKCorePatient | 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 | Content/Rules for all slices | |||
birthPlace | N | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | N | 1..1 | Address | The registered place of birth of the patient. |
birthSex | N | 0..1 | CodeableConcept | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) |
cadavericDonor | N | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |
value[x] | N | 1..1 | boolean | Post-mortem donor status. |
contactPreference | N | 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 | N | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus |
ethnicCategory | N | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person. |
residentialStatus | N | 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 | N | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |
value[x] | N | 1..1 | boolean | Indicator showing whether the patient needs an interpreter |
nhsNumberUnavailableReason | N | 0..1 | CodeableConcept | Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible) |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
identifier:nhsNumber | 0..1 | NHSNumbers | UK National Health Identifiers | |
Slices for extension | Content/Rules for all slices | |||
nhsNumberVerificationStatus | N | 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 | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:MedicalRecordNumber | SΣ | 0..* | MedicalRecordNumber | Medical Record Number |
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..* | HumanName | A name associated with the patient |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
telecom | SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
Slices for extension | Content/Rules for all slices | |||
otherContactSystem | N | 0..1 | CodeableConcept | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) |
value | SΣ | 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. |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
Slices for extension | Content/Rules for all slices | |||
birthTime | N | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |
value[x] | N | 1..1 | dateTime | Time of day of birth. |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | SΣ | 0..* | Address | An address for the individual |
Slices for extension | Content/Rules for all slices | |||
addressKey | N | 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 |
line | SΣ | 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 | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
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 | ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided |
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.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 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.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | UKCorePatient | 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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
birthPlace | N | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | N | 1..1 | Address | The registered place of birth of the patient. | ||||
birthSex | N | 0..1 | CodeableConcept | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | ||||
cadavericDonor | N | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |||||
value[x] | N | 1..1 | boolean | Post-mortem donor status. | ||||
contactPreference | N | 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 | N | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | ||||
ethnicCategory | N | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person. | ||||
residentialStatus | N | 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 | N | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |||||
value[x] | N | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | ||||
nhsNumberUnavailableReason | N | 0..1 | CodeableConcept | Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible) | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
identifier:nhsNumber | 0..1 | NHSNumbers | UK National Health Identifiers | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
nhsNumberVerificationStatus | N | 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 | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
identifier:MedicalRecordNumber | SΣ | 0..* | MedicalRecordNumber | Medical Record Number | ||||
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | SΣ | 1..* | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | ΣC | 0..1 | Period | Time period when name was/is in use per-1: If present, start SHALL have a lower value than end | ||||
telecom | SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
otherContactSystem | N | 0..1 | CodeableConcept | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | ||||
value | 0..1 | code | Primitive value for code Max Length: 1048576 | |||||
value | SΣ | 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 | ΣC | 0..1 | Period | Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end | ||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
birthTime | N | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |||||
value[x] | N | 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 | SΣ | 0..* | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
addressKey | N | 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 | SΣ | 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 | SΣ | 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 | SΣ | 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 | ΣC | 0..1 | Period | Time period when address was/is in use per-1: If present, start SHALL have a lower value than end 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 | C | 0..* | Attachment | Image of the patient att-1: If the Attachment has data, it SHALL have a contentType | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
contactRank | N | 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 | N | 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): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | C | 0..* | ContactPoint | A contact detail for the person cpt-2: A system is required if a value is provided. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 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 | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
otherContactSystem | N | 0..1 | CodeableConcept | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | ||||
value | 0..1 | code | Primitive value for code Max Length: 1048576 | |||||
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 | ΣC | 0..1 | Period | Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end | ||||
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(Organization) | Organization that is associated with the contact ref-1: SHALL have a contained resource if a local reference is provided | ||||
period | C | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
proficiency | N | 0..1 | (Complex) | Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
extension:level | N | 0..1 | Extension | The proficiency level of the communication | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "level" | |||||
value[x] | N | 1..1 | Coding | The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication. | ||||
extension:type | N | 0..* | Extension | The proficiency type of the communication | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "type" | |||||
value[x] | N | 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: AllLanguages (required): A ValueSet that identifies the language used by a person.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided | ||||
managingOrganization | ΣC | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided | ||||
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.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 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.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 | required | AllLanguages
http://hl7.org/fhir/ValueSet/all-languages | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
This structure is derived from UKCorePatient
Differential View
This structure is derived from UKCorePatient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | UKCorePatient | |||
identifier | 1..* | Identifier | An identifier for this patient | |
Slices for identifier | Content/Rules for all slices | |||
identifier:nhsNumber | 0..1 | NHSNumbers | UK National Health Identifiers | |
identifier:MedicalRecordNumber | 0..* | MedicalRecordNumber | Medical Record Number | |
name | 1..* | HumanName | A name associated with the patient | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | UKCorePatient | 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 | Content/Rules for all slices | |||
birthPlace | N | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
value[x] | N | 1..1 | Address | The registered place of birth of the patient. |
birthSex | N | 0..1 | CodeableConcept | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) |
cadavericDonor | N | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |
value[x] | N | 1..1 | boolean | Post-mortem donor status. |
contactPreference | N | 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 | N | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus |
ethnicCategory | N | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person. |
residentialStatus | N | 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 | N | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |
value[x] | N | 1..1 | boolean | Indicator showing whether the patient needs an interpreter |
nhsNumberUnavailableReason | N | 0..1 | CodeableConcept | Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible) |
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system |
identifier:nhsNumber | 0..1 | NHSNumbers | UK National Health Identifiers | |
Slices for extension | Content/Rules for all slices | |||
nhsNumberVerificationStatus | N | 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 | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
identifier:MedicalRecordNumber | SΣ | 0..* | MedicalRecordNumber | Medical Record Number |
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use |
name | SΣ | 1..* | HumanName | A name associated with the patient |
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
telecom | SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. |
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
Slices for extension | Content/Rules for all slices | |||
otherContactSystem | N | 0..1 | CodeableConcept | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) |
value | SΣ | 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. |
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
birthDate | SΣ | 0..1 | date | The date of birth for the individual |
Slices for extension | Content/Rules for all slices | |||
birthTime | N | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
extension | N | 0..0 | ||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |
value[x] | N | 1..1 | dateTime | Time of day of birth. |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
address | SΣ | 0..* | Address | An address for the individual |
Slices for extension | Content/Rules for all slices | |||
addressKey | N | 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 |
line | SΣ | 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 | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
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 | ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided |
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.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 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.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | UKCorePatient | 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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
birthPlace | N | 0..1 | (Complex) | The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | N | 1..1 | Address | The registered place of birth of the patient. | ||||
birthSex | N | 0..1 | CodeableConcept | The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) | ||||
cadavericDonor | N | 0..1 | (Complex) | Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" | |||||
value[x] | N | 1..1 | boolean | Post-mortem donor status. | ||||
contactPreference | N | 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 | N | 0..1 | (Complex) | The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus | ||||
ethnicCategory | N | 0..1 | CodeableConcept | The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person. | ||||
residentialStatus | N | 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 | N | 0..1 | (Complex) | Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" | |||||
value[x] | N | 1..1 | boolean | Indicator showing whether the patient needs an interpreter | ||||
nhsNumberUnavailableReason | N | 0..1 | CodeableConcept | Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible) | ||||
modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
Slices for identifier | SΣ | 1..* | Identifier | An identifier for this patient Slice: Unordered, Open by value:system | ||||
identifier:nhsNumber | 0..1 | NHSNumbers | UK National Health Identifiers | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
nhsNumberVerificationStatus | N | 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 | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣC | 0..1 | Period | Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end | ||||
assigner | ΣC | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided | ||||
identifier:MedicalRecordNumber | SΣ | 0..* | MedicalRecordNumber | Medical Record Number | ||||
active | ?!SΣ | 0..1 | boolean | Whether this patient's record is in active use | ||||
name | SΣ | 1..* | HumanName | A name associated with the patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') | ||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | ΣC | 0..1 | Period | Time period when name was/is in use per-1: If present, start SHALL have a lower value than end | ||||
telecom | SΣC | 0..* | ContactPoint | A contact detail for the individual cpt-2: A system is required if a value is provided. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
otherContactSystem | N | 0..1 | CodeableConcept | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | ||||
value | 0..1 | code | Primitive value for code Max Length: 1048576 | |||||
value | SΣ | 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 | ΣC | 0..1 | Period | Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end | ||||
gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | SΣ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
birthTime | N | 0..1 | (Complex) | Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthTime" | |||||
value[x] | N | 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 | SΣ | 0..* | Address | An address for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
addressKey | N | 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 | SΣ | 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 | SΣ | 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 | SΣ | 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 | ΣC | 0..1 | Period | Time period when address was/is in use per-1: If present, start SHALL have a lower value than end 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 | C | 0..* | Attachment | Image of the patient att-1: If the Attachment has data, it SHALL have a contentType | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
contactRank | N | 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 | N | 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): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 0..1 | HumanName | A name associated with the contact person | |||||
telecom | C | 0..* | ContactPoint | A contact detail for the person cpt-2: A system is required if a value is provided. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 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 | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
otherContactSystem | N | 0..1 | CodeableConcept | Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible) | ||||
value | 0..1 | code | Primitive value for code Max Length: 1048576 | |||||
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 | ΣC | 0..1 | Period | Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end | ||||
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(Organization) | Organization that is associated with the contact ref-1: SHALL have a contained resource if a local reference is provided | ||||
period | C | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
proficiency | N | 0..1 | (Complex) | Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
extension:level | N | 0..1 | Extension | The proficiency level of the communication | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "level" | |||||
value[x] | N | 1..1 | Coding | The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication. | ||||
extension:type | N | 0..* | Extension | The proficiency type of the communication | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | N | 0..0 | ||||||
url | 1..1 | uri | "type" | |||||
value[x] | N | 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: AllLanguages (required): A ValueSet that identifies the language used by a person.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
generalPractitioner | C | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided | ||||
managingOrganization | ΣC | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided | ||||
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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
other | ΣC | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided | ||||
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.name.use | required | NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 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.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 | required | AllLanguages
http://hl7.org/fhir/ValueSet/all-languages | ||||
Patient.link.type | required | LinkTypehttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
This structure is derived from UKCorePatient
Other representations of profile: CSV, Excel, Schematron