CareConnect-Patient-1
Patient | |
Definition | |
Control | 0..* |
Type | Patient |
Comments | |
Patient.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
Comments |
The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
Patient.meta | |
Definition |
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 ? |
Type | Meta |
Comments | |
Patient.implicitRules | |
Definition |
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | True |
Comments |
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Patient.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
Comments |
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Patient.text | |
Definition |
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 ? |
Type | Narrative |
Aliases | narrative, html, xhtml, display |
Comments |
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Patient.contained | |
Definition |
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Aliases | inline resources, anonymous resources, contained resources |
Comments |
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Patient.extension(registrationDetails) | |
Definition | |
Control | 0..* |
Type | Extension |
Comments | |
Patient.extension(ethnicCategory) | |
Definition | |
Control | 0..1 |
Type | Extension |
Comments | |
Patient.extension(religiousAffiliation) | |
Definition | |
Control | 0..1 |
Type | Extension |
Comments | |
Patient.extension(patient-cadavericDonor) | |
Definition | |
Control | 0..1 |
Type | Extension |
Comments | |
Patient.extension(residentialStatus) | |
Definition | |
Control | 0..* |
Type | Extension |
Comments | |
Patient.extension(treatmentCategory) | |
Definition | |
Control | 0..* |
Type | Extension |
Comments | |
Patient.extension(nhsCommunication) | |
Definition | |
Control | 0..* |
Type | Extension |
Comments | |
Patient.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.identifier(nhsNumber) | |
Definition |
The patient's NHS number |
Control | 0..1 |
Comments | |
Patient.identifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.identifier.extension(nhsNumberVerificationStatus) | |
Definition | |
Control | 1..1 |
Type | Extension |
Comments | |
Patient.identifier.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | https://fhir.nhs.uk/Id/nhs-number |
Patient.identifier.value | |
Definition | |
Control | 1..* |
Comments | |
Patient.identifier(localIdentifier) | |
Definition | |
Control | 0..* |
Comments | |
Patient.identifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.identifier.extension | |
Definition | |
Control | 0..* |
Comments | |
Patient.identifier.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | https://fhir.nhs.uk/Id/nhs-number |
Patient.identifier.value | |
Definition | |
Control | 1..* |
Comments | |
Patient.active | |
Definition |
Whether this patient record is in active use. |
Control | 0..1 ? |
Type | Boolean |
Is Modifier | True |
Requirements |
Need to be able to mark a patient record as not to be used because it was created in error. |
Comments |
Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
Default Value | true |
Patient.name(usual) | |
Definition |
The patient's current usual name |
Control | 1..1 |
Comments | |
Patient.name.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.name.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.name.use | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | usual |
Patient.name.text | |
Definition |
A full text representation of the name. |
Control | 0..1 ? |
Type | String |
Requirements |
A renderable, unencoded form. |
Comments |
Can provide both a text representation and structured parts. |
Patient.name.family | |
Definition | |
Control | 1..1 |
Comments | |
Patient.name.given | |
Definition |
Given name. |
Control | 0..* ? |
Type | String |
Aliases | first name, middle name |
Comments |
If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. |
Patient.name.prefix | |
Definition | |
Control | 0..1 |
Comments | |
Patient.name.suffix | |
Definition | |
Control | 0..1 |
Comments | |
Patient.name.period | |
Definition |
Indicates the period of time when this name was valid for the named person. |
Control | 0..1 ? |
Type | Period |
Requirements |
Allows names to be placed in historical context. |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Patient.name.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.name.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.name.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.name(other) | |
Definition |
The patient's other names |
Control | 0..* |
Comments | |
Patient.name.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.name.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.name.use | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | usual |
Patient.name.text | |
Definition |
A full text representation of the name. |
Control | 0..1 ? |
Type | String |
Requirements |
A renderable, unencoded form. |
Comments |
Can provide both a text representation and structured parts. |
Patient.name.family | |
Definition | |
Control | 1..1 |
Comments | |
Patient.name.given | |
Definition |
Given name. |
Control | 0..* ? |
Type | String |
Aliases | first name, middle name |
Comments |
If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. |
Patient.name.prefix | |
Definition | |
Control | 0..1 |
Comments | |
Patient.name.suffix | |
Definition | |
Control | 0..1 |
Comments | |
Patient.name.period | |
Definition |
Indicates the period of time when this name was valid for the named person. |
Control | 0..1 ? |
Type | Period |
Requirements |
Allows names to be placed in historical context. |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Patient.name.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.name.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.name.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.telecom | |
Definition |
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
Control | 0..* ? |
Type | ContactPoint |
Requirements |
People have (primary) ways to contact them in some way such as phone, email. |
Comments |
A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). |
Patient.telecom.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.telecom.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.telecom.system | |
Definition | |
Control | 1..* |
Comments | |
Patient.telecom.value | |
Definition | |
Control | 1..* |
Comments | |
Patient.telecom.use | |
Definition |
Identifies the purpose for the contact point. |
Control | 0..1 ? |
Binding |
Use of contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use |
Type | Code |
Is Modifier | True |
Requirements |
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Patient.telecom.period | |
Definition |
Time period when the contact point was/is in use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Patient.telecom.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.telecom.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.telecom.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.telecom.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Patient.gender | |
Definition | |
Control | 1..* |
Binding |
The codes SHALL be taken from https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1 |
Comments | |
Patient.birthDate | |
Definition | |
Control | 1..* |
Comments | |
Patient.birthDate.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.birthDate.extension(patient-birthTime) | |
Definition | |
Control | 0..* |
Type | Extension |
Comments | |
Patient.deceased[x] | |
Definition |
Indicates if the individual is deceased or not. |
Control | 0..1 ? |
Type | Choice of: |
Is Modifier | True |
Requirements |
The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. |
Comments |
If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
Patient.address | |
Definition |
Addresses for the individual. |
Control | 0..* ? |
Type | Address |
Requirements |
May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
Comments |
Patient may have multiple addresses with different uses or applicable periods. |
Patient.address.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.address.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.address.use | |
Definition |
The purpose of this address. |
Control | 0..1 ? |
Binding |
The use of an address The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows an appropriate address to be chosen from a list of many. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Example | home |
Patient.address.type | |
Definition |
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Control | 0..1 ? |
Binding |
The type of an address (physical / postal) The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-type |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Example | both |
Patient.address.text | |
Definition | |
Control | 0..* |
Comments | |
Example | 42 Grove Street, Overtown, West Yorkshire, LS21 1PF |
Patient.address.line | |
Definition | |
Control | 0..* |
Comments | |
Example | 42, Grove Street |
Patient.address.city | |
Definition | |
Control | 0..* |
Comments | |
Example | Overtown |
Patient.address.district | |
Definition | |
Control | 0..* |
Comments | |
Example | West Yorkshire |
Patient.address.postalCode | |
Definition | |
Control | 0..* |
Comments | |
Example | LS21 1PF |
Patient.address.country | |
Definition | |
Control | 0..* |
Comments | |
Example | GBR |
Patient.address.period | |
Definition |
Time period when address was/is in use. |
Control | 0..1 ? |
Type | Period |
Requirements |
Allows addresses to be placed in historical context. |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Example | Hl7.Fhir.Model.Period |
Patient.address.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.address.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.address.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.address.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Patient.maritalStatus | |
Definition | |
Control | 0..* |
Binding |
The codes SHALL be taken from https://fhir.hl7.org.uk/ValueSet/CareConnect-MaritalStatus-1 |
Comments | |
Patient.maritalStatus.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.maritalStatus.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.maritalStatus.coding | |
Definition | |
Control | 1..1 |
Comments | |
Patient.maritalStatus.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.maritalStatus.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.maritalStatus.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://hl7.org/fhir/v3/MaritalStatus |
Patient.maritalStatus.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Patient.maritalStatus.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Patient.multipleBirth[x] | |
Definition |
Indicates whether the patient is part of a multiple or indicates the actual birth order. |
Control | 0..1 ? |
Type | Choice of: |
Requirements |
For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. |
Comments | |
Patient.contact | |
Definition |
A contact party (e.g. guardian, partner, friend) for the patient. |
Control | 0..* ? |
Type | BackboneElement |
Requirements |
Need to track people you can contact about the patient. |
Comments |
Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. |
Patient.contact.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.relationship | |
Definition | |
Control | 0..* |
Binding |
The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. https://fhir.hl7.org.uk/ValueSet/CareConnect-PersonRelationshipType-1 |
Comments | |
Patient.contact.relationship.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.relationship.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.relationship.coding | |
Definition |
A reference to a code defined by a terminology system. |
Control | 0..* ? |
Type | Coding |
Requirements |
Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments |
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
Patient.contact.relationship.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.relationship.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.relationship.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Example | https://fhir.hl7.org.uk/CareConnect-PersonRelationshipType-1 |
Patient.contact.relationship.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Patient.contact.relationship.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Patient.contact.name | |
Definition | |
Control | 1..* |
Comments | |
Patient.contact.name.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.name.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.name.use | |
Definition | |
Control | 1..* |
Comments | |
Patient.contact.name.family | |
Definition | |
Control | 1..1 |
Comments | |
Patient.contact.name.given | |
Definition |
Given name. |
Control | 0..* ? |
Type | String |
Aliases | first name, middle name |
Comments |
If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. |
Patient.contact.name.prefix | |
Definition | |
Control | 0..1 |
Comments | |
Patient.contact.name.suffix | |
Definition | |
Control | 0..1 |
Comments | |
Patient.contact.telecom | |
Definition |
A contact detail for the person, e.g. a telephone number or an email address. |
Control | 0..* ? |
Type | ContactPoint |
Requirements |
People have (primary) ways to contact them in some way such as phone, email. |
Comments |
Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Patient.contact.telecom.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.telecom.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.telecom.system | |
Definition |
Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 0..1 ? |
Binding |
Telecommunications form for contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Patient.contact.telecom.value | |
Definition |
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Control | 0..1 ? |
Type | String |
Requirements |
Need to support legacy numbers that are not in a tightly controlled format. |
Comments |
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Patient.contact.telecom.use | |
Definition |
Identifies the purpose for the contact point. |
Control | 0..1 ? |
Binding |
Use of contact point The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use |
Type | Code |
Is Modifier | True |
Requirements |
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Patient.contact.telecom.period | |
Definition |
Time period when the contact point was/is in use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Patient.contact.telecom.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.telecom.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.telecom.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.contact.telecom.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Patient.contact.address | |
Definition |
Address for the contact person. |
Control | 0..1 ? |
Type | Address |
Requirements |
Need to keep track where the contact person can be contacted per postal mail or visited. |
Comments |
Note: address is for postal addresses, not physical locations. |
Patient.contact.address.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.address.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.address.use | |
Definition |
The purpose of this address. |
Control | 0..1 ? |
Binding |
The use of an address The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows an appropriate address to be chosen from a list of many. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Example | home |
Patient.contact.address.type | |
Definition |
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Control | 0..1 ? |
Binding |
The type of an address (physical / postal) The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-type |
Type | Code |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Example | both |
Patient.contact.address.text | |
Definition | |
Control | 0..* |
Comments | |
Example | 120, Grove Street, Overtown, West Yorkshire, LS21 1PT |
Patient.contact.address.line | |
Definition | |
Control | 0..* |
Comments | |
Example | 120, Grove Street |
Patient.contact.address.city | |
Definition | |
Control | 0..* |
Comments | |
Example | Overtown |
Patient.contact.address.district | |
Definition | |
Control | 0..* |
Comments | |
Example | West Yorkshire |
Patient.contact.address.postalCode | |
Definition | |
Control | 0..* |
Comments | |
Example | LS21 1PT |
Patient.contact.address.country | |
Definition | |
Control | 0..* |
Comments | |
Example | GBR |
Patient.contact.address.period | |
Definition |
Time period when address was/is in use. |
Control | 0..1 ? |
Type | Period |
Requirements |
Allows addresses to be placed in historical context. |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Example | Hl7.Fhir.Model.Period |
Patient.contact.address.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.address.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.address.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.contact.address.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Patient.contact.gender | |
Definition | |
Control | 0..* |
Binding |
The codes SHALL be taken from https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1 |
Comments | |
Patient.contact.organization | |
Definition |
Organization on behalf of which the contact is acting or for which the contact is working. |
Control | 0..1 ? |
Type | Organization |
Requirements |
For guardians or business related contacts, the organization is relevant. |
Comments | |
Patient.contact.organization.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.organization.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.organization.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Patient.contact.organization.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Patient.contact.period | |
Definition |
The period during which this contact person or organization is valid to be contacted relating to this patient. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Patient.contact.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.contact.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.contact.period.start | |
Definition |
The start of the period. The boundary is inclusive. |
Control | 0..1 ? |
Type | DateTime |
Comments |
If the low element is missing, the meaning is that the low boundary is not known. |
Patient.contact.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Patient.careProvider | |
Definition | |
Control | 0..1 |
Type | Choice of: |
Comments | |
Patient.managingOrganization | |
Definition | |
Control | 0..* |
Type | https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Organization-1 |
Comments | |
Patient.managingOrganization.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.managingOrganization.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.managingOrganization.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Patient.managingOrganization.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Patient.link | |
Definition |
Link to another patient resource that concerns the same actual patient. |
Control | 0..* ? |
Type | BackboneElement |
Is Modifier | True |
Requirements |
There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers. |
Comments |
There is no assumption that linked patient records have mutual links. |
Patient.link.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.link.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.link.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.link.other | |
Definition | |
Control | 0..* |
Type | https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Patient-1 |
Comments | |
Patient.link.other.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Patient.link.other.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, user content |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Patient.link.other.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Patient.link.other.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Patient.link.type | |
Definition |
The type of link between this patient resource and another patient resource. |
Control | 1..1 ? |
Binding |
The type of link between this patient resource and another patient resource. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/link-type |
Type | Code |
Is Modifier | True |
Comments |
Note that FHIR strings may not exceed 1MB in size |