The Patient resource carries the patient demographic details.
Name | Card. | Type | Description & Constraints |
---|---|---|---|
Patient | Patient | This Patient resource is constrained for the Care Connect API interaction requirements | |
registrationDetails | 0..1 | Extension | Additional registration information for the Patient resource Extension http://fhir.nhs.net/StructureDefinition/extension-registration-details-1 |
birthTime | 0..1 | Extension | The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. Extension http://hl7.org/fhir/StructureDefinition/patient-birthTime |
ethnicCategory | 0..1 | Extension | Ethnicity of the patient Extension http://fhir.nhs.net/StructureDefinition/extension-ethnic-category-1 |
religiousAffiliation | 0..1 | Extension | The religion as specified by the patient Extension http://fhir.nhs.net/StructureDefinition/extension-religious-affiliation-snct-1 |
organDonor | 0..1 | Extension | An indicator that the patient is listed as an organ donor. Extension http://fhir.nhs.net/StructureDefinition/extension-organ-donor-1 |
residentialStatus | 0..1 | Extension | The residential status of the patient. Extension http://fhir.nhs.net/StructureDefinition/extension-residential-status-1 |
treatmentCategory | 0..1 | Extension | The treatment category for this patient. Extension http://fhir.nhs.net/StructureDefinition/extension-treatment-category-1 |
nhsCommunication | 0..* | Extension | NHS communication preferences for a resource Extension http://fhir.nhs.net/StructureDefinition/extension-nhs-communication-1 |
identifier | An identifier for this patient Slice: Ordering: Unordered, Discriminator: system, Rules: Open at End | ||
identifier (NHSNumber) | 0..1 | Identifier | An NHS Number identifier for this patient |
nhsNumberVerificationStatus | 0..1 | Extension | NHS number verification status Extension http://fhir.nhs.net/StructureDefinition/extension-nhsnumberverificationstatus-1 |
system | 1..1 | Uri | The namespace for the identifier Fixed Value http://fhir.nhs.net/Id/nhs-number |
value | 1..1 | String | The value that is unique Example Value 9900002831 |
identifier (other) | 0..* | Identifier | An identifier for this patient |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength Required |
type | 0..1 | CodeableConcept | Description of identifier Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength Extensible |
coding | 0..* | Coding | Code defined by a terminology system |
system | 0..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 0..1 | Code | Symbol in syntax defined by the system |
display | 0..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 0..1 | Uri | The namespace for the identifier Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | 0..1 | String | The value that is unique Example Value 123456 |
period | 0..1 | Period | Time period when id is/was valid for use |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Reference (careconnect-organization-1) | Organization that issued id (may be just text) |
reference | 0..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
active | 0..1 | Boolean | Whether this patient's record is in active use Default Value true |
name | A name associated with the patient Slice: Ordering: Unordered, Rules: Open at End | ||
name (usual) | 0..1 | HumanName | A name associated with the patient |
use | 1..1 | Code | usual | official | temp | nickname | anonymous | old | maiden Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use) Binding Strength Required Fixed Value usual |
text | 0..1 | String | Text representation of the full name |
family | 1..1 | String | Family name (often called 'Surname') |
given | 0..* | String | Given names (not always 'first'). Includes middle names |
prefix | 0..* | String | Parts that come before the name |
suffix | 0..* | String | Parts that come after the name |
period | 0..1 | Period | Time period when name was/is in use |
start | 0..1 | DateTime | Starting time with inclusive boundary |
name (other) | 0..* | HumanName | A name associated with the patient |
use | 0..1 | Code | usual | official | temp | nickname | anonymous | old | maiden Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use) Binding Strength Required |
text | 0..1 | String | Text representation of the full name |
family | 1..1 | String | Family name (often called 'Surname') |
given | 0..* | String | Given names (not always 'first'). Includes middle names |
prefix | 0..* | String | Parts that come before the name |
suffix | 0..* | String | Parts that come after the name |
period | 0..1 | Period | Time period when name was/is in use |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
telecom | 0..* | ContactPoint | A contact detail for the individual |
system | 1..1 | Code | phone | fax | email | url Binding Telecommunications form for contact point (http://hl7.org/fhir/valueset-contact-point-system) Binding Strength Required Example Value phone |
value | 1..1 | String | The actual contact point details Example Value 0113-245-1919 |
use | 0..1 | Code | home | work | temp | old | mobile - purpose of this contact point Binding Use of contact point (http://hl7.org/fhir/DSTU2/valueset-contact-point-use) Binding Strength Required Example Value home |
period | 0..1 | Period | Time period when the contact point was/is in use |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
gender | 1..1 | Code | Gender for administrative purposes Binding The gender of a person used for administrative purposes. (http://fhir.nhs.net/ValueSet/administrative-gender-1) Binding Strength Required Example Value female |
birthDate | 1..1 | Date | The date of birth for the patient |
deceased[x] | 0..1 | Boolean | DateTime | Indicates if the individual is deceased or not |
address | 0..* | Address | Address details for the patient |
use | 0..1 | Code | home | work | temp | old - purpose of this address Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use) Binding Strength Required Example Value home |
type | 0..1 | Code | postal | physical | both Binding The type of an address (physical/postal) (http://hl7.org/fhir/ValueSet/address-type) Binding Strength Required Example Value both |
text | 0..1 | String | Text representation of the address Example Value 42 Grove Street, Overtown, West Yorkshire, LS21 1PF |
line | 0..* | String | Street name, number etc. Example Value 42, Grove Street |
city | 0..1 | String | Name of city, town etc. Example Value Overtown |
district | 0..1 | String | District name (aka county) Example Value West Yorkshire |
postalCode | 0..1 | String | Postal code for area Example Value LS21 1PF |
country | 0..1 | String | Country (can be ISO 3166 3 letter code) Example Value GBR |
period | 0..1 | Period | Time period when address was/is in use Example Value Hl7.Fhir.Model.Period |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding The domestic partnership status of a person. (http://fhir.nhs.net/ValueSet/marital-status-1) Binding Strength Required |
coding | 0..1 | Coding | A code taken from the marital status list of codes. |
system | 1..1 | Uri | Identity of the terminology system Fixed Value http://hl7.org/fhir/ValueSet/marital-status |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value M |
display | 1..1 | String | Representation defined by the system Example Value Married |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
multipleBirth[x] | 0..1 | Boolean | Integer | Whether patient is part of a multiple birth |
contact | 0..* | BackboneElement | A contact (e.g. guardian, partner, friend) for the patient |
relationship | 0..* | CodeableConcept | The kind of relationship to the patient Binding The kind of relationship to the patient (http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1) Binding Strength Required |
coding | 0..1 | Coding | A code taken from the CDA Person Relationship Type list of codes. Binding A code taken from the CDA Person Relationship Type list of codes. (http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1) Binding Strength Required |
system | 1..1 | Uri | Identity of the terminology system Fixed Value http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1 |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value 43 |
display | 1..1 | String | Representation defined by the system Example Value Daughter |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
name | 0..1 | HumanName | A name associated with the contact person. |
use | 0..1 | Code | usual | official | temp | nickname | anonymous | old | maiden Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use) Binding Strength Required Example Value usual |
text | 0..1 | String | Text representation of the full name |
family | 1..1 | String | Family name (often called 'Surname') Example Value Taylor |
given | 0..* | String | Given names (not always 'first'). Includes middle names Example Value Ann |
prefix | 0..* | String | Parts that come before the name Example Value Miss |
suffix | 0..* | String | Parts that come after the name |
telecom | 0..* | ContactPoint | A contact detail for the contact person |
system | 0..1 | Code | phone | fax | email | url Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system) Binding Strength Required Example Value phone |
value | 0..1 | String | The actual contact point details Example Value 0113-245-0909 |
use | 0..1 | Code | home | work | temp | old | mobile - purpose of this contact point Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use) Binding Strength Required Example Value home |
period | 0..1 | Period | Time period when the contact point was/is in use |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
address | 0..1 | Address | Address for the contact person. |
use | 0..1 | Code | home | work | temp | old - purpose of this address Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use) Binding Strength Required Example Value home |
type | 0..1 | Code | postal | physical | both Binding The type of an address (physical / postal (http://hl7.org/fhir/ValueSet/address-type) Binding Strength Required Example Value both |
text | 0..1 | String | Text representation of the address Example Value 120, Grove Street, Overtown, West Yorkshire, LS21 1PT |
line | 0..* | String | Street name, number etc Example Value 120, Grove Street |
city | 0..1 | String | Name of city, town etc. Example Value Overtown |
district | 0..1 | String | District name (aka county) Example Value West Yorkshire |
postalCode | 0..1 | String | Postal code for area Example Value LS21 1PT |
country | 0..1 | String | Country (can be ISO 3166 3 letter code) Example Value GBR |
period | 0..1 | Period | Time period when address was/is in use Example Value Hl7.Fhir.Model.Period |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
gender | 0..1 | Code | Gender for administrative purposes Binding The gender of a person used for administrative purposes (http://fhir.nhs.net/ValueSet/administrative-gender-1) Binding Strength Required Example Value female |
organization | 0..1 | Reference (careconnect-organization-1) | Organization that is associated with the contact for the patient |
reference | 0..1 | String | Relative URL reference to the Organization resource |
display | 0..1 | String | Narrative text for the resource |
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient |
start | 0..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
careProvider | 0..* | Reference (careconnect-organization-1 | careconnect-practitioner-1) | Patient's nominated care provider |
managingOrganization | 0..1 | Reference (careconnect-organization-1) | Organization that is the custodian of the patient record |
reference | 0..1 | String | Relative URL reference to the Organization resource |
display | 0..1 | String | Narrative text for the resource |
link | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
other | 1..1 | Reference (careconnect-patient-1) | The other patient resource that the link refers to |
reference | 0..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
type | 1..1 | Code | replace | refer | seealso - type of link Binding The type of link between this patient resource and another patient resource. (http://hl7.org/fhir/ValueSet/link-type) Binding Strength Required |
Name | Type | Description & Constraints |
---|---|---|
Extension-Registration-Details-1 | Extension | This extension is defined to support the additional registration information recorded by the healthcare organization for the Patient resource. |
Patient-BirthTime | Extension | This Extension resource is constrained to support the patients birth time. |
Extension-Ethnic-Category-1 | Extension | This Extension resource is constrained to support the ethnic category for the Patient resource. |
Extension-Religious-Affiliation-SnCT-1 | Extension | This Extension resource is constrained to support the religious affiliation for the Patient resource. |
Extension-Organ-Donor-1 | Extension | This Extension resource is constrained to support the organ donor status for the Patient resource. |
Extension-Residential-Status-1 | Extension | This Extension resource is constrained to support the residential status for the Patient resource. |
Extension-Treatment-Category-1 | Extension | This Extension resource is constrained to support the treatment category for the Patient resource. |
Extension-NHS-Communication-1 | Extension | This extension is defined to support communication in the NHS for a resource. |
Extension-NHSNumberVerificationStatus-1 | Extension | This Extension resource is constrained to support the NHS number verification status for the Patient resource. |