The FHIR profiles used for the Birth Details Event Message Bundle
The following FHIR profiles are used to form the Birth Details Event Message Bundle:
- NHSD-Bundle-1
- NHSD-MessageHeader-1 - where the coding and display for the event element is fixed to ‘CH005 - Birth Details’ XXXXXXXXXXXXXXX
- CareConnect-NHSD-Organization-1
- NHSD-HealthcareService-1
- CareConnect-NHSD-Patient-1
- CareConnect-NSHD-Encounter-1 - where the type element is represented using Child Health Encounter type ‘003 - Birth’ XXXXXXXXXXXXXXXX
- CareConnect-NHSD-Condition-1
- CareConnect-NHSD-Observation-1
- CareConnect-NHSD-Procedure-1
- CareConnect-NHSD-Location-1
Birth Details Event data item mapping to FHIR profiles
The Child Health Event data items are fulfilled by elements within the FHIR resources listed below:
Mapping for Bundle
| > | Level 1 | Bundle Resource | > | Level 2 | None | > | Level 3 | NHSD-Bundle-1 Profile |
| View All FHIR Elements | View Used Elements Only |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Maternity-Record Implementation |
|---|---|---|---|---|
| Bundle | | Contains a collection of resources Constraint (bdl-7): FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId Constraint (bdl-9): A document must have an identifier with a system and a value Constraint (bdl-3): Entry.Request Only For Some Types Of Bundles Constraint (bdl-4): Entry.Response Only For Some Types Of Bundles Constraint (bdl-1): Total Only When A Search Or History Constraint (bdl-2): Entry.Search Only When A Search |
||
| - id | 0..1 | Mandatory | Id | Must contain a UUID to identify the instance of a bundle |
| - meta | 0..1 | Mandatory | Meta | The profile element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/NHSD-Bundle-1 |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content . Binding (extensible): A human language. ( http://hl7.org/fhir/stu3/valueset-languages.html ) |
| - identifier | 0..1 | Not Used | Identifier | Persistent identifier for the bundle |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known . ( http://hl7.org/fhir/stu3/valueset-identifier-use.html ) |
| - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ( http://hl7.org/fhir/stu3/valueset-identifier-type.html ) |
| - - system | 1..1 | Not Used | Uri | The namespace for the identifier value |
| - - value | 1..1 | Not Used | String | The value that is unique |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - assigner | 0..1 | Not Used | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-NHSD-Organization-1 | |||
| - type | 1..1 | Mandatory | Code | document : message : transaction : transaction-response : batch : batch-response : history : searchset : collection Binding (required): Indicates the purpose of a bundle - how it was intended to be used. (http://hl7.org/fhir/stu3/valueset-bundle-type.html ) Fixed Value: “message” |
| - entry | 1..* | Mandatory | BackboneElement | Entry in the bundle - will have a resource, or information Constraint (bdl-8): fullUrl cannot be a version specific reference Constraint (bdl-5): Must Be A Resource Unless There’S A Request Or Response |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - fullUrl | 0..1 | Mandatory | Uri | Absolute URL for resource (server address, or UUID/OID). This MUST be a UUID prefixed by urn:uuid: |
| - - resource | 1..1 | Mandatory | Resource | A resource in the bundle. This MUST be to the message Header resource profiled as NHSD-MessageHeader-1 |
Mapping for MessageHeader
| > | Level 1 | MessageHeader Resource | > | Level 2 | None | > | Level 3 | NHSD-MessageHeader-1 Profile |
| View All FHIR Elements | View Used Elements Only |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Maternity-Record Implementation |
|---|---|---|---|---|
| MessageHeader | | A resource that describes a message that is exchanged between systems 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 | 1..1 | Mandatory | Id | Logical id of this artifact. This MUST be a UUID. |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource. The profile element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/NHSD-MessageHeader-1 |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content Binding (extensible): A human language. ( http://hl7.org/fhir/stu3/valueset-languages.html ) |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - extension (messageEventType) | 1..1 | Mandatory | Extension-Maternity-Record-MessageEventType-1 | The url attribute of the extension element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/Extension-Maternity-Record-MessageEventType-1 and populated as per specified here. |
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
| - event | 0..* | Mandatory | Coding | Code for the event this message represents - Binding (required): The type of Child Health Event. |
| - - system | 1..1 | Mandatory | Uri | Identity of the terminology system. MUST contain the Fixed Value: “https://fhir.nhs.uk/STU3/CodeSystem/Maternity-Record-ChildHealthEventType-1” |
| - - version | 1..1 | Not Used | String | Version of the system - if relevant |
| - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system. MUST contain a value from the ValueSet ( https://fhir.nhs.uk/STU3/ValueSet/Maternity-Record-ChildHealthEventType-1 |
| - - display | 1..1 | Mandatory | String | Representation defined by the system. MUST contain the display text assoicated with the code carried in the code element |
| - timestamp | 1..1 | Mandatory | Instant | Time that the message was sent |
| - source | 1..1 | Mandatory | BackboneElement | Message source application |
| - - modifierExtension | 1..1 | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - name | 0..* | Not Used | String | Name of system |
| - - software | 0..1 | Not Used | String | Name of software running the system |
| - - version | 0..1 | Not Used | String | Version of software running |
| - - contact | 0..1 | Not Used | ContactPoint | Human contact for problems Constraint (cpt-2): A system is required if a value is provided. |
| - - - system | 0..1 | Not Used | Code | phone : fax : email : pager : url : sms : other. Binding (required): Telecommunications form for contact point ( http://hl7.org/fhir/stu3/valueset-contact-point-system.html ) |
| - - - value | 0..1 | Not Used | String | The actual contact point details |
| - - - use | 0..1 | Not Used | Code | home : work : temp : old : mobile - purpose of this contact point. Binding (required): Use of contact point ( http://hl7.org/fhir/stu3/valueset-contact-point-use.html ) |
| - - - rank | 0..1 | Not Used | positiveInt | Specify preferred order of use (1 = highest) |
| - - - period | 0..1 | Not Used | Period | Time period when the contact point was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - endpoint | 1..1 | Mandatory | Uri | Actual message source address or id |
| - responsible | 1..1 | Mandatory | Reference | Final responsibility for event Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-NHSD-Organization-1 | The responsible organization carried in the Organizaion resource in the bundle. This MUST be to the Organization resource profiled as CareConnect-NHSD-Organization-1 | ||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - focus | 1..1 | Mandatory | Reference | The actual content of the message Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-NHSD-Encounter-1 | The focus resource in the bundle. This MUST be to the encounter resource profiled as CareConnect-NHSD-Encounter-1 | ||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
Mapping for Encounter
| > | Level 1 | Encounter Resource | > | Level 2 | CareConnect-Encounter-1 | > | Level 3 | CareConnect-NHSD-Encounter-1 Profile |
| View All FHIR Elements | View Used Elements Only |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for XXX Implementation |
|---|---|---|---|---|
| Encounter | | An interaction during which services are provided to the patient 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 | Not Used | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | The profile element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-NHSD-Encounter-1 |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content. Binding (extensible): A human language. ( http://hl7.org/fhir/stu3/valueset-languages.html ) |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
| - identifier | 0..1 | Mandatory | Identifier | Identifier(s) by which this encounter is known. |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value |
| - - value | 1..1 | Mandatory | String | The value that is unique. This MUST be a UUID |
| - status | 1..1 | Mandatory | Code | planned : arrived : triaged : in-progress : onleave : finished : cancelled. Binding (required): Current state of the encounter ( http://hl7.org/fhir/stu3/valueset-encounter-status.html)) |
| - type | 0..* | Mandatory | CodeableConcept | Code defined by a terminology system Binding (required): The type of Child Health encounter ( https://fhir.nhs.uk/STU3/ValueSet/Maternity-Record-ChildHealthEncounterType-1 ) |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Mandatory | Coding | Code defined by a terminology system. Binding (required): The type of Child Health encounter ( https://fhir.nhs.uk/STU3/ValueSet/Maternity-Record-ChildHealthEncounterType-1 ) |
| - - - extension (snomedCTDescriptionID) | 0..* | Not Used | Extension-coding-sctdesid | Additional Content defined by implementations. Constraint (ext-1): Must have either extensions or value[x], not both. |
| - - - url | 1..1 | Not Used | Uri | Identifies The Meaning Of The Extension Fixed Value: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid |
| - - - value[x] | 0..1 | Not Used | * | Value of extension |
| - - system | 1..1 | Mandatory | Uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system. MUST contain a code from the stated ValueSet |
| - - display | 1..1 | Mandatory | String | Representation defined by the system. MUST contain the preferred term for the concept |
| - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - subject | 1..1 | Mandatory | Reference | The patient present at the encounter Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-NHSD-Patient-1 | |||
| - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - participant | 0..* | Not Used | BackboneElement | List of participants involved in the encounter |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - type | 0..* | Not Used | CodeableConcept | Role of participant in encounter. Binding (extensible): Role of participant in encounter ( http://hl7.org/fhir/stu3/valueset-encounter-participant-type.html ) |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - period | 0..1 | Not Used | Period | Period of time during the encounter that the participant participated Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - individual | 0..1 | Not Used | Reference | Persons involved in the encounter other than the patient Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-NHSD-Practitioner-1 | |||
| Not Used | NHSD-RelatedPerson-1 | |||
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - period | 1..1 | Not Used | Period | The start and end time of the encounter Constraint (per-1): If present, start SHALL have a lower value than end |
| - - start | 1..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - reason | 0..1 | Not Used | CodeableConcept | Reason the encounter takes place (code). Binding (preferred): Reason why the encounter takes place. ( http://hl7.org/fhir/stu3/valueset-encounter-reason.html ) |
| - - coding (snomedCT) | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - extension (snomedCTDescriptionID) | 0..* | Not Used | Extension-coding-sctdesid | Additional Content defined by implementations. Constraint (ext-1): Must have either extensions or value[x], not both. |
| - - - - url | 1..1 | Not Used | Uri | Identifies The Meaning Of The Extension. Fixed Value: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid |
| - - - - value[x] | 0..1 | Not Used | * | Value of extension |
| - - - system | 1..1 | Not Used | Uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 1..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - hospitalization | 0..1 | Not Used | BackboneElement | Details about the admission to a healthcare service |
| - - extension (admissionMethod) | 0..* | Not Used | Extension-CareConnect-AdmissionMethod-1 | Additional Content defined by implementations Constraint (ext-1): Must have either extensions or value[x], not both |
| - - - url | 1..1 | Not Used | Uri | Identifies The Meaning Of The Extension Fixed Value: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-AdmissionMethod-1 |
| - - - value[x] | 0..1 | Not Used | * | Value of extension |
| - - extension (dischargeMethod) | 0..* | Not Used | Extension-CareConnect-DischargeMethod-1 | Additional Content defined by implementations Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-1 |
| - - - url | 1..1 | Not Used | Uri | Identifies The Meaning Of The Extension Fixed Value: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DischargeMethod-1 |
| - - - value[x] | 0..1 | Not Used | * | Value of extension |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - admitSource | 0..1 | Not Used | CodeableConcept | From where patient was admitted (physician referral, transfer). Binding (required): The source of admission to a Hospital Provider Spell or a Nursing Episode when the Patient is in a Hospital Site or a Care Home. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SourceOfAdmission-1 ) |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-SourceOfAdmission-1 |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - destination | 0..1 | Not Used | Reference | Location to which the patient is discharged Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| 0.1 | Not Used | CareConnect-NHSD-Location | ||
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - dischargeDisposition | 0..1 | Not Used | CodeableConcept | Category or kind of location after discharge. Binding (required): The destination of a Patient on completion of a Hospital Provider Spell, or a note that the Patient died or was a still birth. ( https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-DischargeDestination-1 ) |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-DischargeDestination-1 |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - location | 1..1 | Not Used | BackboneElement | List of locations where the patient has been |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - location | 1..1 | Not Used | Reference | Location the encounter takes place Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-NHSD-Location-1 | |||
| - - - reference | 1..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - status | 0..1 | Not Used | String | Text alternative for the resource |
| 0..1 | Not Used | Code | planned : active : reserved : completed. Binding (required): The status of the location. ( http://hl7.org/fhir/stu3/valueset-encounter-location-status.html ) | |
| - - - period | 0..1 | Not Used | Period | Time period during which the patient was present at the location Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - serviceProvider | 1..1 | Not Used | Reference | The custodian organization of this Encounter record Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-NHSD-Organization-1 | |||
| - - - reference | 1..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
Mapping for Patient
| Name | Card. | Conformance | Type | Description, Constraints and mapping for XXX Implementation |
| Patient | | Information about an individual 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 | Not Used | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource. The profile element MUST contain the value https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-NHSD-Patient-1 |
| - implicitRules | 0..1 | Not Used | Uri | A set of rules under which this content was created |
| - language | 0..1 | Not Used | Code | Language of the resource content. Binding (extensible): A human language. ( http://hl7.org/fhir/stu3/valueset-languages.html ) |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - extension (ethnicCategory) | 0..1 | Not Used | Extension-CareConnect-EthnicCategory-1 | Ethnic category Constraint (ext-1): Must have either extensions or value[x], not both Must be populated as specified here |
| - extension (religiousAffiliation) | 0..1 | Not Used | Extension | Religious affiliation Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 |
| - extension (patient-cadavericDonor) | 0..1 | Not Used | Extension | Flag indicating whether the patient authorized the donation of body parts after death Constraint (ext-1): Must have either extensions or value[x], not both URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor |
| - extension (residentialStatus) | 0..1 | Not Used | Extension | The residential status of the patient Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 |
| - extension (treatmentCategory) | 0..1 | Not Used | Extension | The treatment category for this patient Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 |
| - extension (nhsCommunication) | 0..* | Not Used | Extension | NHS communication preferences for a resource Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 |
| - extension (birthPlace) | 0..1 | Not Used | Extension | Birth Place: The registered place of birth of the patient. Constraint (ext-1): Must have either extensions or value[x], not both URL: http://hl7.org/fhir/StructureDefinition/birthPlace |
| - extension (nominatedPharmacy) | 0..1 | Not Used | Extension | A patient’s nominated pharmacy Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 |
| - extension (deathNotificationStatus) | 0..1 | Not Used | Extension | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) Constraint (ext-1): Must have either extensions or value[x], not both URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 |
| - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both Slicing: Description: Extensions are always sliced by (at least) url, Discriminator: url, Ordering: false, Rules: Open |
| - identifier | 0..* | Mandatory | Identifier | An identifier for this patient Slicing: Discriminator: system, Ordering: false, Rules: Open at End |
| - - identifier (nhsNumber) | 0..1 | Mandatory | Identifier | The patient’s 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 |
| - - use | 0..1 | Not Used | Code | usual | official | temp | secondary (If known)Binding (required): Identifies the purpose for this identifier, if known . ( http://hl7.org/fhir/stu3/valueset-identifier-use.html ) |
| - - type | 0..1 | Not Used | CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ( http://hl7.org/fhir/stu3/valueset-identifier-type.html ) |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
| - - value | 1..1 | Mandatory | String | The value that is unique |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - assigner | 0..1 | Not Used | Reference ( CareConnect-Organization-1 ) | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - active | 0..1 | Not Used | Boolean | Whether this patient’s record is in active use Default Value: true |
| - 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 |
| - - use | 1..1 | Mandatory | Code | usual | official | temp | nickname | anonymous | old | maidenFixed Value: official Binding (required): The use of a human name ( https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-NameUse-1 ) |
| - - text | 0..1 | Select | String | Text representation of the full name |
| - - family | 1..1 | Select | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Select | String | Given names (not always ‘first’). Includes middle names |
| - - prefix | 0..* | Select | String | Parts that come before the name |
| - - suffix | 0..* | Select | String | Parts that come after the name |
| - - period | 0..1 | Select | Period | Time period when name was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Select | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Select | dateTime | End time with inclusive boundary, if not ongoing |
| - name (other) | 0..* | Select | HumanName | A name associated with the patient |
| - - use | 1..1 | Select | Code | usual | official | temp | nickname | anonymous | old | maidenBinding (required): The use of a human name ( https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-NameUse-1 ) |
| - - text | 0..1 | Not Used | String | Text representation of the full name |
| - - family | 0..1 | Mandatory | String | Family name (often called ‘Surname’) |
| - - given | 0..* | Mandatory | 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 |
| - - period | 0..1 | Not Used | Period | Time period when name was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - telecom | 0..* | Not Used | ContactPoint | A contact detail for the individual Constraint (cpt-2): A system is required if a value is provided. |
| - - system | 1..1 | Not Used | Code | phone | fax | email | pager | url | sms | otherBinding (required): Telecommunications form for contact point ( http://hl7.org/fhir/stu3/valueset-contact-point-system.html ) |
| - - value | 1..1 | Not Used | String | The actual contact point details |
| - - use | 0..1 | Not Used | Code | home | work | temp | old | mobile - purpose of this contact pointBinding (required): Use of contact point ( http://hl7.org/fhir/stu3/valueset-contact-point-use.html ) |
| - - rank | 0..1 | Not Used | positiveInt | Specify preferred order of use (1 = highest) |
| - - period | 0..1 | Not Used | Period | Time period when the contact point was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - gender | 0..1 | Mandatory | Code | male | female | other | unknownBinding (required): The gender of a person used for administrative purposes. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-AdministrativeGender-1 ) |
| - birthDate | 0..1 | Mandatory | Date | The date of birth for the individual |
| - - extension (patient-birthTime) | 0..1 | Mandatory | Extension | The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively. Constraint (ext-1): Must have either extensions or value[x], not both URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
| - deceased[x] | 0..1 | Not Used | Boolean | dateTime |
Indicates if the individual is deceased or not |
| - address | 0..* | Mandatory | Address | Addresses for the individual |
| - - use | 0..1 | Mandatory | Code | home | work | temp | old - purpose of this addressBinding (required): The use of an address ( http://hl7.org/fhir/stu3/valueset-address-use.html ) |
| - - type | 0..1 | Not Used | Code | postal | physical | bothBinding (required): The type of an address (physical / postal) ( http://hl7.org/fhir/stu3/valueset-address-type.html ) |
| - - text | 0..1 | Not Used | String | Text representation of the address |
| - - line | 0..* | Mandatory | String | Street name, number, direction & P.O. Box etc. |
| - - city | 0..1 | Mandatory | String | Name of city, town etc. |
| - - district | 0..1 | Not Used | String | District name (aka county) |
| - - state | 0..1 | Not Used | String | Sub-unit of country (abbreviations ok) |
| - - postalCode | 0..1 | Mandatory | String | Postal code for area |
| - - country | 0..1 | Not Used | String | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| - - period | 0..1 | Not Used | Period | Time period when address was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - maritalStatus | 0..1 | Not Used | CodeableConcept | Marital (civil) status of a patient Binding (required): The domestic partnership status of a person. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-MaritalStatus-1 ) |
| - - coding | 1..1 | Not Used | Coding | Code defined by a terminology system |
| - - - system | 1..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 1..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 1..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - multipleBirth[x] | 0..1 | Mandatory | Boolean | Integer |
Whether patient is part of a multiple birth |
| - photo | 0..* | Not Used | Attachment | Image of the patient Constraint (att-1): It the Attachment has data, it SHALL have a contentType |
| - - contentType | 0..1 | Not Used | Code | Mime type of the content, with charset etc. Binding (required): The mime type of an attachment. Any valid mime type is allowed. ( http://www.rfc-editor.org/bcp/bcp13.txt ) |
| - - language | 0..1 | Not Used | Code | Human language of the content (BCP-47) Binding (extensible): A human language. ( http://hl7.org/fhir/stu3/valueset-languages.html ) |
| - - data | 0..1 | Not Used | base64Binary | Data inline, base64ed |
| - - url | 0..1 | Not Used | Uri | Uri where the data can be found |
| - - size | 0..1 | Not Used | unsignedInt | Number of bytes of content (if url provided) |
| - - hash | 0..1 | Not Used | base64Binary | Hash of the data (sha-1, base64ed) |
| - - title | 0..1 | Not Used | String | Label to display in place of the data |
| - - creation | 0..1 | Not Used | dateTime | Date attachment was first created |
| - contact | 0..* | Not Used | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraint (pat-1): SHALL at least contain a contact’s details or a reference to an organization |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - relationship | 0..* | Not Used | CodeableConcept | The kind of relationship Binding (extensible): The nature of the relationship between a patient and a contact person for that patient. (http://hl7.org/fhir/ValueSet/v2-0131 ) |
| - - - coding | 0..* | Not Used | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Not Used | Uri | Identity of the terminology system |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - code | 0..1 | Not Used | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Not Used | String | Representation defined by the system |
| - - - userSelected | 0..1 | Not Used | Boolean | If this coding was chosen directly by the user |
| - - text | 0..1 | Not Used | String | Plain text representation of the concept |
| - - name | 1..1 | Not Used | HumanName | A name associated with the contact person |
| - - - use | 1..1 | Not Used | Code | usual | official | temp | nickname | anonymous | old | maidenBinding (required): The use of a human name ( http://hl7.org/fhir/stu3/valueset-name-use.html ) |
| - - - text | 0..1 | Not Used | String | Text representation of the full name |
| - - - family | 0..1 | Not Used | String | Family name (often called ‘Surname’) |
| - - - given | 0..* | Not Used | String | Given names (not always ‘first’). Includes middle names |
| - - - prefix | 0..* | Not Used | String | Parts that come before the name |
| - - - suffix | 0..* | Not Used | String | Parts that come after the name |
| - - - period | 0..1 | Not Used | Period | Time period when name was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - telecom | 0..* | Not Used | ContactPoint | A contact detail for the person Constraint (cpt-2): A system is required if a value is provided. |
| - - - system | 0..1 | Not Used | Code | phone | fax | email | pager | url | sms | otherBinding (required): Telecommunications form for contact point ( http://hl7.org/fhir/stu3/valueset-contact-point-system.html ) |
| - - - value | 0..1 | Not Used | String | The actual contact point details |
| - - - use | 0..1 | Not Used | Code | home | work | temp | old | mobile - purpose of this contact pointBinding (required): Use of contact point ( http://hl7.org/fhir/stu3/valueset-contact-point-use.html ) |
| - - - rank | 0..1 | Not Used | positiveInt | Specify preferred order of use (1 = highest) |
| - - - period | 0..1 | Not Used | Period | Time period when the contact point was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - address | 0..1 | Not Used | Address | Address for the contact person |
| - - - use | 0..1 | Not Used | Code | home | work | temp | old - purpose of this addressBinding (required): The use of an address ( http://hl7.org/fhir/stu3/valueset-address-use.html ) |
| - - - type | 0..1 | Not Used | Code | postal | physical | bothBinding (required): The type of an address (physical / postal) ( http://hl7.org/fhir/stu3/valueset-address-type.html ) |
| - - - text | 0..1 | Not Used | String | Text representation of the address |
| - - - line | 0..* | Not Used | String | Street name, number, direction & P.O. Box etc. |
| - - - city | 0..1 | Not Used | String | Name of city, town etc. |
| - - - district | 0..1 | Not Used | String | District name (aka county) |
| - - - state | 0..1 | Not Used | String | Sub-unit of country (abbreviations ok) |
| - - - postalCode | 0..1 | Not Used | String | Postal code for area |
| - - - country | 0..1 | Not Used | String | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| - - - period | 0..1 | Not Used | Period | Time period when address was/is in use Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - - gender | 0..1 | Not Used | Code | male | female | other | unknownBinding (required): The gender of a person used for administrative purposes. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-AdministrativeGender-1 ) |
| - - organization | 0..1 | Not Used | Reference ( CareConnect-Organization-1 ) | Organization that is associated with the contact Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - - - period | 0..1 | Not Used | Period | The period during which this contact person or organization is valid to be contacted relating to this patient Constraint (per-1): If present, start SHALL have a lower value than end |
| - - - - start | 0..1 | Not Used | dateTime | Starting time with inclusive boundary |
| - - - - end | 0..1 | Not Used | dateTime | End time with inclusive boundary, if not ongoing |
| - generalPractitioner | 0..* | Not Used | Reference ( CareConnect-Organization-1 | CareConnect-Practitioner-1 ) |
Patient’s nominated primary care provider Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - managingOrganization | 0..1 | Not Used | Reference ( CareConnect-Organization-1 ) | Organization that is the custodian of the patient record Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - display | 0..1 | Not Used | String | Text alternative for the resource |
| - link | 0..* | Not Used | BackboneElement | Link to another patient resource that concerns the same actual person |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - other | 1..1 | Not Used | Reference ( RelatedPerson |CareConnect-Patient-1 ) |
The other patient or related person resource that the link refers to Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - - reference | 0..1 | Not Used | String | Literal reference, Relative, internal or absolute URL |
| - - - identifier | 0..1 | Not Used | Identifier | Logical reference, when literal reference is not known |
| - - - display | 0..1 | Not Used | String | Text alternative for the resource |
| Maternity-Record Data Item | FHIR resource element | Mandatory/Required/Optional |
|---|---|---|
| Location of Birth | CareConnect-Maternity-Record-Delivery-Location-1.identifier (ODS Site Code) | Required |
| Delivery Place Type Code | CareConnect-Maternity-Record-Delivery-Location-1.physicalType | Mandatory |
| Birth Order | CareConnect-Maternity-Record-Patient-1.multipleBirthInteger | Mandatory |
| Length of Gestation at Birth | CareConnect-Maternity-Record-LengthOfGestation-Observation-1.valueQuantity | Mandatory |
| Number of Births in confinement | CareConnect-Maternity-Record-NumberOfBirths-Observation-1.valueQuantity | Mandatory |
| Problems during Delivery | CareConnect-Maternity-Record-ProblemDuringDelivery-Condition-1.code | Required |
| Physical Problems detected at Birth | CareConnect-Maternity-Record-PhysicalProblemAtBirth-Condition-1.code | Required |
| Neonatal Resuscitation Method | CareConnect-Maternity-Record-NeonatalResuscitationMethod-Procedure-1.code | Required |
| Date and Time of Birth | CareConnect-Maternity-Record-Patient-1.birthDate (with patient-BirthTime extension) | Mandatory |
| Type of Delivery | CareConnect-Maternity-Record-FinalDeliveryType-Procedure-1.code | Mandatory |
| Attempted Type of Delivery | CareConnect-Maternity-Record-AttemptedDeliveryType-Condition-1.code | Required |
| Onset of Spontaneous Respiration | CareConnect-Maternity-Record-SpontaneousRespirationOnset-Observation-1.component | Optional |
| APGAR Score (1 Minute) | CareConnect-Maternity-Record-APGARScore-Observation-1.valueQuantity | Mandatory |
| APGAR Score (5 Minute) | CareConnect-Maternity-Record-APGARScore-Observation-1.valueQuantity | Mandatory |
| APGAR Score (10 Minute) | CareConnect-Maternity-Record-APGARScore-Observation-1.valueQuantity | Optional |
| Put To Breast | CareConnect-Maternity-Record-PutToBreastIndicator-Observation-1.code | Required |
| Identical Twin Indicator | CareConnect-Maternity-Record-IdenticalTwinIndicator-Observation-1.code | Optional |