The FHIR profiles used for the Patient demographics list structure
Heading Description
This heading holds all of the elements for each instance of a patient demographics entry.
The following FHIR profiles are used to form the Patient demographics list structure:
The following profiles are referenced from the Patient demographics list structure:
- None
Patient Demographics Structure
Maternity data standard Mapping to FHIR profiles
The following tables detail how to populate the FHIR resources and the mapping to the Maternity data standard.
Mapping for Patient Demographics List
| > | Level 1 | List Resource | > | Level 2 | CareConnect-List-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| List | | Information summarized from a list of other resources Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource Constraint (lst-2): The deleted flag can only be used if the mode of the list is “changes” Constraint (lst-1): A list can only have an emptyReason if it is empty |
||
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-List-1' |
| - identifier | 0..* | Required | Identifier | Business identifier An identifier for this Patient demographics list |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Mandatory | String | The value that is unique Business identifier An identifier for this Patient demographics list |
| - - - display | 0..1 | Required | String | Text alternative for the resource The organization that allocated the identifier |
| - status | 1..1 | Mandatory | Code | current : retired : entered-in-error Binding (required): The current state of the list ListStatus The status of the list MUST contain the value 'current' |
| - mode | 1..1 | Mandatory | Code | working : snapshot : changes Binding (required): The processing mode that applies to this list ListMode The mode of the list MUST contain the value 'snapshot' |
| - title | 0..1 | Mandatory | String | Descriptive name for the list This MUST contain the value 'Patient demographics' Mapping to Maternity data item = 'PSRB Heading patient demographics' |
| - code | 0..1 | Mandatory | CodeableConcept | What the purpose of this list is Binding (preferred): What the purpose of a list is CareConnect-ListCode-1 The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system The SNOMED CT concept for the PRSB heading type |
| - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system This MUST contain the value 'http://snomed.info/sct' |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system This MUST contain the value '886731000000109' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Patient demographics' Mapping to Maternity data item = 'PSRB Heading Patient demographics' |
| - subject | 0..1 | Mandatory | Reference | If all resources have the same subject Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the Patient who is the subject of the list. |
| Mandatory | CareConnect-Patient-1 |
This is the subject of the Admission details List. This MUST use the CareConnect patient profile. See patient resource reference for information on how to populate the resource. |
||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle |
| - date | 0..1 | Mandatory | dateTime | When the list was prepared This MUST contain a system date to indicate when the list was created or updated |
| - note | 0..* | Optional | Annotation | Comments about the list |
| Required | String | Who authored the comment on the list. | ||
| - - time | 0..1 | Required | dateTime | When the annotation was made |
| - - text | 1..1 | Required | String | The annotation - text content |
| - entry | 0..* | Mandatory | BackboneElement | Entries in the list The entries MUST be as per the diagram for this PRSB headings list with the Observation resource being the focal resource. |
| - - date | 0..1 | Required | dateTime | When item added to list The SHOULD contain a system time of when the item was added to the list. |
| - - item | 1..1 | Required | Reference | Actual entry Constraint (ref-1): SHALL have a contained resource if a local reference is provided A reference to an Observation resource included in the list This MUST use the CareConnect Observation profile. See Observation resource for information on how to populate the resource. |
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL The reference to the included Observation resource. |
Mapping for Patient Demographics Patient
| > | Level 1 | Patient Resource | > | Level 2 | CareConnect-Patient-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Patient | | Information about an individual or animal receiving health care services Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
||
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 1..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1' |
| - extension (ethnicCategory) | 0..1 | Required | Ethnic category - The ethnicity of the person Constraint (ext-1): Must have either extensions or value[x], not both An extension to the Patient resource See Ethnic category extension for information on how to populate this extension to the resource. Mapping to Maternity data item = 'Ethnicity'. |
|
| - extension (religiousAffiliation) | 0..1 | Required | Extension-CareConnect-EthnicCategory-1 | Religious affiliation - The religious affiliation as specified by the person. Constraint (ext-1): Must have either extensions or value[x], not both An extension to the Patient resource See Religious affiliation extension for information on how to populate this extension to the resource. Mapping to Maternity data item = 'Religion'. |
| - extension (birthPlace) | 0..1 | Required | birthPlace | Birth Place: The registered place of birth of the patient. Constraint (ext-1): Must have either extensions or value[x], not both A common extension to the Patient resource See Birth place extension for information on how to populate this extension to the resource. Mapping to Maternity data item = 'Place of Birth'. The town and country of birth of the patient |
| - identifier | 0..* | Required | Identifier | An identifier for this patient Slicing: Discriminator: system, Ordering: false, Rules: Open at End |
| - identifier (nhsNumber) | 0..1 | Required | Identifier | The patient’s NHS number. The unique identifier for a patient within the NHS in England and Wales. Mapping to Maternity data item = 'NHS number'. |
| - - extension (nhsNumberVerificationStatus) | 1..1 | Mandatory | Extension-CareConnect-NHSNumberVerificationStatus-1 | NHS number verification status Constraint (ext-1): Must have either extensions or value[x], not both An extension to the Patient resource See NHS number vertification status extension for information on how to populate this extension to the resource. |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value The value attribute of the profile element MUST contain the value 'https://fhir.nhs.uk/Id/nhs-number' |
| - - value | 1..1 | Mandatory | String | The value that is unique The unique identifier for a patient within the NHS in England and Wales. |
| - name | 1..* | Mandatory | HumanName | A name associated with the patient Slicing: Discriminator: use, Ordering: false, Rules: Open at End |
| - name (official) | 1..1 | Mandatory | HumanName | A name associated with the patient. The full name of the patient. This will normally be given by a Personal Demographics Service (PDS) patient trace, or the name of the patient held on the local Patient Administration System (PAS). Mapping to Maternity data item = 'Patient name'. |
| - - use | 1..1 | Mandatory | Code | usual : official : temp : nickname : anonymous : old : maiden The value attribute of the profile element MUST contain the value 'official' Binding (required): The use of a human name CareConnect-NameUse-1 |
| - - text | 0..1 | Required | String | Text representation of the full name |
| - - family | 1..1 | Mandatory | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Required | String | Given names (not always ‘first’). Includes middle names |
| - - prefix | 0..* | Required | String | Parts that come before the name |
| - - suffix | 0..* | Required | String | Parts that come after the name |
| - telecom | 0..* | Required | ContactPoint | A contact detail for the individual Constraint (cpt-2): A system is required if a value is provided. Telephone contact details of the patient. To include, e.g. mobile, work and home number if available and/or the email address of the patient Mapping to Maternity data item = 'Patient telephone number' and/or 'Patient email address' |
| - - system | 1..1 | Required | Code | phone : fax : email : pager : url : sms : other Binding (required): Telecommunications form for contact point ContactPointSystem |
| - - value | 1..1 | Required | String | The actual contact point details |
| - - use | 0..1 | Required | Code | home : work : temp : old : mobile - purpose of this contact point Binding (required): Use of contact point ContactPointUse |
| - - rank | 0..1 | Required | positiveInt | Specify preferred order of use (1 = highest) |
| - gender | 0..1 | Required | Code | male : female : other : unknown Binding (required): The gender of a person used for administrative purposes. CareConnect-AdministrativeGender-1 As the patient wishes to portray themselves. Mapping to Maternity data item = 'Gender' |
| - birthDate | 0..1 | Required | Date | The date of birth for the individual Mapping to Maternity data item ='Date of Birth' |
| - deceased[x] | 0..1 | Required | Boolean | Indicates if the individual is deceased or not |
| Required | dateTime | The date and time when the patient died Mapping to Maternity data item = 'Date of Death and Time of Date' |
||
| - address | 0..* | Required | Address | Addresses for the individual. Patient’s usual place of residence.as per PDS five address line + postcode format Mapping to Maternity data item ='Patient address' |
| - - use | 0..1 | Required | Code | home : work : temp : old - purpose of this address Binding (required): The use of an address AddressUse |
| - - line | 0..* | Required | String | Street name, number, direction & P.O. Box etc. Patient’s usual place of residence.as per PDS five address line format |
| - - postalCode | 0..1 | Required | String | Postal code for area Patient’s postcode PDS format |
| - maritalStatus | 0..1 | Required | CodeableConcept | Marital (civil) status of a patient Binding (required): The domestic partnership status of a person. CareConnect-MaritalStatus-1 An indicator to identify the legal marital status of the person. The FHIR valueSet MUST be used and mapped to NHS Data Dictionary codes Mapping to Maternity data item = 'Marital Status'. |
| - - coding | 1..1 | Required | Coding | Code defined by a terminology system |
| - - - system | 1..1 | Required | Uri | Identity of the terminology system This MUST contain the value https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-MaritalStatus-1 |
| - - - code | 1..1 | Required | Code | Symbol in syntax defined by the system This MUST contain a code from the above valueSet |
| - - - display | 1..1 | Required | String | Representation defined by the system This MUST contain the display assoicated with the code |
Mapping for Patient Demographics Observation
| > | Level 1 | Observation Resource | > | Level 2 | CareConnect-Observation-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Observation | | Measurements and simple assertions Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource Constraint (obs-7): If code is the same as a component code then the value element associated with the code SHALL NOT be present Constraint (obs-6): dataAbsentReason SHALL only be present if Observation.value[x] is not present |
||
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1' |
| - status | 1..1 | Mandatory | Code | registered : preliminary : final : amended + Binding (required): Codes providing the status of an observation. ObservationStatus This MUST contain the value 'final' |
| - code | 1..1 | Mandatory | CodeableConcept | Type of observation (code / type) Binding (example): Codes identifying names of simple observations. LOINC Codes The woman’s phenotypic sex. Determines how the woman will be treated clinically. |
| - - coding | 0..1 | Required | Coding | Code defined by a terminology system Slicing: Discriminator: code, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Mandatory | Coding | Code defined by a terminology system Binding (extensible): A code from the SNOMED Clinical Terminology UK coding system describing a type of observation CareConnect-ObservationType-1 This uses a SNOMED CT concept to describe this observation as one of patient's sex Mapping to Maternity data item = 'Patient sex'. |
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system This MUST contain the value '184100006' |
| - - - display | 1..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Patient sex' |
| Mandatory | CodeableConcept | The system element MUST contain the identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
||
| The code element MUST contain the symbol in syntax defined by the system This MUST contain the value '248152002' |
||||
| The display element MUST contain the representation defined by the system This MUST contain the value 'Female' |
Mapping for Patient Demographics Extension Ethnic category
| > | Level 1 | Extension | > | Level 2 | CareConnect-EthnicCategory-1 | > | Level 3 | None |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Extension | | Ethnic category Constraint (ele-1): All FHIR elements must have a @value or children Constraint (ext-1): Must have either extensions or value[x], not both |
||
| - id | 0..1 | Optional | String | xml:id (or equivalent in JSON) |
| - url | 1..1 | Mandatory | Uri | Identifies The Meaning Of The Extension Fixed Value = ‘https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1’ |
| - valueCodeableConcept | 1..1 | Mandatory | CodeableConcept | A code classifying the person’s ethnicity Binding (required): A code classifying the person’s ethnicity. CareConnect-EthnicCategory-1 |
Mapping for Patient Demographics Extension Religious Affiliation
| > | Level 1 | Extension | > | Level 2 | CareConnect-ReligiousAffiliation-1 | > | Level 3 | None |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Extension | | Religious affiliation Constraint (ele-1): All FHIR elements must have a @value or children Constraint (ext-1): Must have either extensions or value[x], not both |
||
| - id | 0..1 | Optional | String | xml:id (or equivalent in JSON) |
| - url | 1..1 | Mandatory | Uri | Identifies The Meaning Of The Extension Fixed Value = ‘https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1’ |
| - valueCodeableConcept | 1..1 | Mandatory | CodeableConcept | A code classifying the person’s religious affiliation Binding (required): A code classifying the person’s ethnicity.CareConnect-ReligiousAffiliation-1 |
