Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1 | Version: 0.1.0 | |||
Draft as of 2019-05-31 | Computable Name: CareConnectPatient1 | |||
Copyright/Legal: Copyright © 2019 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html |
The patient resource represents the patient involved in the provision of healthcare related services.
CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ethnicCategory | 0..1 | CodeableConcept | Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity. | |
religiousAffiliation | 0..1 | CodeableConcept | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 Binding: Care Connect Religious Affiliation (required): Religious Affiliation | |
patient-cadavericDonor | 0..1 | boolean | Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 Binding: Care Connect Residential Status (required): Residential Status | |
treatmentCategory | 0..1 | CodeableConcept | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 Binding: Care Connect Treatment Category (required): Treatment Category | |
nhsCommunication | 0..* | (Complex) | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | |
birthPlace | 0..1 | Address | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
nominatedPharmacy | 0..1 | Reference(CareConnect-Organization-1) | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 | |
deathNotificationStatus | 0..1 | (Complex) | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system | |
identifier:nhsNumber | 0..1 | Identifier | The patient's NHS number | |
extension | 1..* | Extension | Extension | |
nhsNumberVerificationStatus | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | |
value | 1..1 | string | The value that is unique Example General: 1234567890 | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open At End by value:use | |
name:official | 1..1 | HumanName | A name associated with the patient | |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | |
family | 1..1 | string | Family name (often called 'Surname') | |
telecom | ||||
system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
value | 1..1 | string | The actual contact point details | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
patient-birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
address | ||||
text | 0..1 | string | Text representation of the address Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. Example General: 42 Grove Street | |
city | 0..1 | string | Name of city, town etc. Example General: Overtown | |
district | 0..1 | string | District name (aka county) Example General: West Yorkshire | |
postalCode | 0..1 | string | Postal code for area Example General: LS21 1PF | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required): The domestic partnership status of a person. | |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
contact | ||||
name | 1..1 | HumanName | A name associated with the contact person | |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
address | ||||
text | 0..1 | string | Text representation of the address Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. Example General: 120, Grove Street | |
city | 0..1 | string | Name of city, town etc. Example General: Overtown | |
district | 0..1 | string | District name (aka county) Example General: West Yorkshire | |
postalCode | 0..1 | string | Postal code for area Example General: LS21 1PT | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
organization | 0..1 | Reference(CareConnect-Organization-1) | Organization that is associated with the contact | |
animal | 0..0 | |||
communication | 0..0 | |||
managingOrganization | 0..1 | Reference(CareConnect-Organization-1) | Organization that is the custodian of the patient record | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.name:official.use | required | Fixed Value: official |
Patient.gender | required | AdministrativeGender |
Patient.maritalStatus | required | Marital Status Codes |
Patient.contact.gender | required | AdministrativeGender |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ethnicCategory | 0..1 | CodeableConcept | Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity. | |
religiousAffiliation | 0..1 | CodeableConcept | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 Binding: Care Connect Religious Affiliation (required): Religious Affiliation | |
patient-cadavericDonor | 0..1 | boolean | Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 Binding: Care Connect Residential Status (required): Residential Status | |
treatmentCategory | 0..1 | CodeableConcept | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 Binding: Care Connect Treatment Category (required): Treatment Category | |
nhsCommunication | 0..* | (Complex) | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | |
birthPlace | 0..1 | Address | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
nominatedPharmacy | 0..1 | Reference(CareConnect-Organization-1) | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 | |
deathNotificationStatus | 0..1 | (Complex) | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system |
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
nhsNumberVerificationStatus | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example General: 1234567890 |
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open At End by value:use |
name:official | Σ | 1..1 | HumanName | A name associated with the patient |
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required): The domestic partnership status of a person. | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.identifier:nhsNumber.use | required | IdentifierUse | ||||
Patient.name:official.use | required | Fixed Value: official | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | required | Marital Status Codes | ||||
Patient.animal.species | example | AnimalSpecies | ||||
Patient.communication.language | extensible | Common Languages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.link | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ethnicCategory | 0..1 | CodeableConcept | Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity. | |||||
religiousAffiliation | 0..1 | CodeableConcept | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 Binding: Care Connect Religious Affiliation (required): Religious Affiliation | |||||
patient-cadavericDonor | 0..1 | boolean | Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |||||
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 Binding: Care Connect Residential Status (required): Residential Status | |||||
treatmentCategory | 0..1 | CodeableConcept | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 Binding: Care Connect Treatment Category (required): Treatment Category | |||||
nhsCommunication | 0..* | (Complex) | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | |||||
birthPlace | 0..1 | Address | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |||||
nominatedPharmacy | 0..1 | Reference(CareConnect-Organization-1) | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 | |||||
deathNotificationStatus | 0..1 | (Complex) | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system | ||||
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nhsNumberVerificationStatus | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example General: 1234567890 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open At End by value:use | ||||
name:official | Σ | 1..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
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 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 | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
patient-birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | Σ | 0..* | Address | Addresses for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old - 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 Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 42 Grove Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: Overtown | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison Example General: West Yorkshire | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 Example General: LS21 1PF | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required): The domestic partnership status of a person. | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..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 | ||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 1..1 | HumanName | A name associated with the contact person | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..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 | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 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 | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old - 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 Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 120, Grove Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: Overtown | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison Example General: West Yorkshire | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 Example General: LS21 1PT | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
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(CareConnect-Organization-1) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | extensible | Common Languages
| ||||
Patient.identifier:nhsNumber.use | required | IdentifierUse | ||||
Patient.identifier:nhsNumber.type | extensible | Identifier Type Codes | ||||
Patient.name:official.use | required | Fixed Value: official | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.maritalStatus | required | Marital Status Codes | ||||
Patient.contact.relationship | extensible | v2 Contact Role | ||||
Patient.contact.name.use | required | NameUse | ||||
Patient.contact.address.use | required | AddressUse | ||||
Patient.contact.address.type | required | AddressType | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.animal.species | example | AnimalSpecies | ||||
Patient.animal.breed | example | AnimalBreeds | ||||
Patient.animal.genderStatus | example | GenderStatus | ||||
Patient.communication.language | extensible | Common Languages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTime, Patient.contact, Patient.link | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |
This structure is derived from Patient
Summary
Mandatory: 4 elements (12 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Patient
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ethnicCategory | 0..1 | CodeableConcept | Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity. | |
religiousAffiliation | 0..1 | CodeableConcept | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 Binding: Care Connect Religious Affiliation (required): Religious Affiliation | |
patient-cadavericDonor | 0..1 | boolean | Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 Binding: Care Connect Residential Status (required): Residential Status | |
treatmentCategory | 0..1 | CodeableConcept | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 Binding: Care Connect Treatment Category (required): Treatment Category | |
nhsCommunication | 0..* | (Complex) | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | |
birthPlace | 0..1 | Address | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
nominatedPharmacy | 0..1 | Reference(CareConnect-Organization-1) | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 | |
deathNotificationStatus | 0..1 | (Complex) | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 | |
Slices for identifier | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system | |
identifier:nhsNumber | 0..1 | Identifier | The patient's NHS number | |
extension | 1..* | Extension | Extension | |
nhsNumberVerificationStatus | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | |
value | 1..1 | string | The value that is unique Example General: 1234567890 | |
assigner | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | |
Slices for name | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open At End by value:use | |
name:official | 1..1 | HumanName | A name associated with the patient | |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | |
family | 1..1 | string | Family name (often called 'Surname') | |
telecom | ||||
system | 1..1 | code | phone | fax | email | pager | url | sms | other | |
value | 1..1 | string | The actual contact point details | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
birthDate | ||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
patient-birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
address | ||||
text | 0..1 | string | Text representation of the address Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. Example General: 42 Grove Street | |
city | 0..1 | string | Name of city, town etc. Example General: Overtown | |
district | 0..1 | string | District name (aka county) Example General: West Yorkshire | |
postalCode | 0..1 | string | Postal code for area Example General: LS21 1PF | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | |
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required): The domestic partnership status of a person. | |
coding | 1..1 | Coding | Code defined by a terminology system | |
system | 1..1 | uri | Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
contact | ||||
name | 1..1 | HumanName | A name associated with the contact person | |
use | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden | |
address | ||||
text | 0..1 | string | Text representation of the address Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT | |
line | 0..* | string | Street name, number, direction & P.O. Box etc. Example General: 120, Grove Street | |
city | 0..1 | string | Name of city, town etc. Example General: Overtown | |
district | 0..1 | string | District name (aka county) Example General: West Yorkshire | |
postalCode | 0..1 | string | Postal code for area Example General: LS21 1PT | |
country | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | |
gender | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |
organization | 0..1 | Reference(CareConnect-Organization-1) | Organization that is associated with the contact | |
animal | 0..0 | |||
communication | 0..0 | |||
managingOrganization | 0..1 | Reference(CareConnect-Organization-1) | Organization that is the custodian of the patient record | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Patient.name:official.use | required | Fixed Value: official |
Patient.gender | required | AdministrativeGender |
Patient.maritalStatus | required | Marital Status Codes |
Patient.contact.gender | required | AdministrativeGender |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ethnicCategory | 0..1 | CodeableConcept | Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity. | |
religiousAffiliation | 0..1 | CodeableConcept | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 Binding: Care Connect Religious Affiliation (required): Religious Affiliation | |
patient-cadavericDonor | 0..1 | boolean | Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 Binding: Care Connect Residential Status (required): Residential Status | |
treatmentCategory | 0..1 | CodeableConcept | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 Binding: Care Connect Treatment Category (required): Treatment Category | |
nhsCommunication | 0..* | (Complex) | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | |
birthPlace | 0..1 | Address | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |
nominatedPharmacy | 0..1 | Reference(CareConnect-Organization-1) | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 | |
deathNotificationStatus | 0..1 | (Complex) | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system |
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
nhsNumberVerificationStatus | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example General: 1234567890 |
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use |
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open At End by value:use |
name:official | Σ | 1..1 | HumanName | A name associated with the patient |
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official |
family | Σ | 1..1 | string | Family name (often called 'Surname') |
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required): The domestic partnership status of a person. | |
coding | Σ | 1..1 | Coding | Code defined by a terminology system |
system | Σ | 1..1 | uri | Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus |
code | Σ | 1..1 | code | Symbol in syntax defined by the system |
display | Σ | 1..1 | string | Representation defined by the system |
managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that is the custodian of the patient record |
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to |
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. |
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.identifier:nhsNumber.use | required | IdentifierUse | ||||
Patient.name:official.use | required | Fixed Value: official | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.maritalStatus | required | Marital Status Codes | ||||
Patient.animal.species | example | AnimalSpecies | ||||
Patient.communication.language | extensible | Common Languages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Patient | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Patient | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Patient | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.link | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | 0..* | Patient | Information about an individual or animal receiving health care services | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
ethnicCategory | 0..1 | CodeableConcept | Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 Binding: Care Connect Ethnic Category (required): A code classifying the person's ethnicity. | |||||
religiousAffiliation | 0..1 | CodeableConcept | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 Binding: Care Connect Religious Affiliation (required): Religious Affiliation | |||||
patient-cadavericDonor | 0..1 | boolean | Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | |||||
residentialStatus | 0..1 | CodeableConcept | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 Binding: Care Connect Residential Status (required): Residential Status | |||||
treatmentCategory | 0..1 | CodeableConcept | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 Binding: Care Connect Treatment Category (required): Treatment Category | |||||
nhsCommunication | 0..* | (Complex) | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 | |||||
birthPlace | 0..1 | Address | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/birthPlace | |||||
nominatedPharmacy | 0..1 | Reference(CareConnect-Organization-1) | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 | |||||
deathNotificationStatus | 0..1 | (Complex) | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 0..* | Identifier | An identifier for this patient Slice: Unordered, Open At End by value:system | ||||
identifier:nhsNumber | Σ | 0..1 | Identifier | The patient's NHS number | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nhsNumberVerificationStatus | 1..1 | CodeableConcept | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 Binding: Care Connect NHS Number Verification Status (required): NHS Number Verification Status | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example General: 1234567890 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ||||
Slices for name | Σ | 1..* | HumanName | A name associated with the patient Slice: Unordered, Open At End by value:use | ||||
name:official | Σ | 1..1 | HumanName | A name associated with the patient | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
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 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 | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point | ||||
value | Σ | 1..1 | string | The actual contact point details | ||||
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date of birth for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
patient-birthTime | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
address | Σ | 0..* | Address | Addresses for the individual | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old - 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 Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 42 Grove Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: Overtown | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison Example General: West Yorkshire | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 Example General: LS21 1PF | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (required): The domestic partnership status of a person. | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..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 | ||||
multipleBirth[x] | 0..1 | Whether patient is part of a multiple birth | ||||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
relationship | 0..* | CodeableConcept | The kind of relationship Binding: v2 Contact Role (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
name | 1..1 | HumanName | A name associated with the contact person | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..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 | Σ | 0..1 | string | Family name (often called 'Surname') | ||||
given | Σ | 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 | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | 0..* | ContactPoint | A contact detail for the person | |||||
address | 0..1 | Address | Address for the contact person | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old - 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 Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Example General: 120, Grove Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example General: Overtown | ||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison Example General: West Yorkshire | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 Example General: LS21 1PT | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
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(CareConnect-Organization-1) | Organization that is associated with the contact | ||||
period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
generalPractitioner | 0..* | Reference(Organization | Practitioner) | Patient's nominated primary care provider | |||||
managingOrganization | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that is the custodian of the patient record | ||||
link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | ||||
type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso - type of link Binding: LinkType (required): The type of link between this patient resource and another patient resource. | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Patient.language | extensible | Common Languages
| ||||
Patient.identifier:nhsNumber.use | required | IdentifierUse | ||||
Patient.identifier:nhsNumber.type | extensible | Identifier Type Codes | ||||
Patient.name:official.use | required | Fixed Value: official | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.maritalStatus | required | Marital Status Codes | ||||
Patient.contact.relationship | extensible | v2 Contact Role | ||||
Patient.contact.name.use | required | NameUse | ||||
Patient.contact.address.use | required | AddressUse | ||||
Patient.contact.address.type | required | AddressType | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.animal.species | example | AnimalSpecies | ||||
Patient.animal.breed | example | AnimalBreeds | ||||
Patient.animal.genderStatus | example | GenderStatus | ||||
Patient.communication.language | extensible | Common Languages
| ||||
Patient.link.type | required | LinkType |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTime, Patient.contact, Patient.link | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Patient.extension:ethnicCategory, Patient.extension:religiousAffiliation, Patient.extension:patient-cadavericDonor, Patient.extension:residentialStatus, Patient.extension:treatmentCategory, Patient.extension:nhsCommunication, Patient.extension:birthPlace, Patient.extension:nominatedPharmacy, Patient.extension:deathNotificationStatus, Patient.birthDate.extension:patient-birthTime | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
pat-1 | error | Patient.contact | SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists() |