The FHIR profiles used for the Demographic history list
Heading Description
This heading holds all of the elements for each instance of a patient demographics history as provided by the PDS previous demographic history flag.
The following FHIR profiles are used to form the Demographics history list structure:
The following profiles are referenced from the Demographics history list structure:
Demographics History 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 Demographic History 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' |
| - 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. Common Languages |
| - text | 0..1 | Not Used | Narrative | Text summary of the resource, for human interpretation |
| - contained | 0..* | Not Used | Resource | Contained, inline Resources |
| - extension (clinicalSetting) | 0..1 | Not Used | Extension-CareConnect-ClinicalSetting-1 | To record the clinical setting of a problem list Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (warningCode) | 0..1 | Not Used | Extension-CareConnect-ListWarningCode-1 | To capture warnings that the list may be incomplete Constraint (ext-1): Must have either extensions or value[x], not both |
| - 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..* | Required | Identifier | Business identifier An identifier for this Demographic history list |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - 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. Identifier Type Codes |
| - - - 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 |
| - - 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 Demographics history list |
| - - period | 0..1 | Not Used | Period | Time period when id is/was valid for use |
| - - - 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 |
| - - 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-Organization-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 | 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 'Demographic history' Mapping to Maternity data item = 'PSRB Heading Demographics history' |
| - 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' |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant Mapping to Maternity Data item = 'Not applicable' |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system This MUST contain the value 'TBA' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Demographic history' Mapping to Maternity data item = 'PSRB Heading Demographic history' |
| - - - 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 |
| - subject | 1..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. |
| Not Used | Group | |||
| Not Used | Device | |||
| Mandatory | CareConnect-Patient-1 | This is the subject of the Demographic history List. This MUST use the CareConnect patient profile. See patient resource reference for information on how to populate the resource. |
||
| Not Used | CareConnect-Location-1 | |||
| - - reference | 0..1 | Not Used | 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 |
| - - 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 |
| - encounter | 0..1 | Not Used | Reference | Context in which list created Constraint (ref-1): SHALL have a contained resource if a local reference is provided A reference to the encounter resource within the Admission details list. |
| Not Used | CareConnect-Encounter-1 | This is the context of the Admission details List. This MUST use the CareConnect encounter profile. See encounter resource for information on how to populate the resource. |
||
| - - 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 |
| - 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 |
| - source | 0..1 | Not Used | Reference | Who and/or what defined the list contents (aka Author) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | Device | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Practitioner-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 |
| - orderedBy | 0..1 | Not Used | CodeableConcept | What order the list has Binding (preferred): What order applies to the items in a list List Order Codes |
| - - 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 |
| - note | 0..* | Optional | Annotation | Comments about the list |
| - - author[x] | 0..1 | Not Used | Reference | Individual responsible for the annotation Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | RelatedPerson | |||
| Not Used | CareConnect-Patient-1 | |||
| Not Used | CareConnect-Practitioner-1 | |||
| 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 Patient resource being the focal resource. |
| - - modifierExtension | 0..* | Not Used | Extension | Extensions that cannot be ignored Constraint (ext-1): Must have either extensions or value[x], not both |
| - - flag | 0..1 | Not Used | CodeableConcept | Status/Workflow information about this item Binding (example): Codes that provide further information about the reason and meaning of the item in the list Patient Medicine Change Types |
| - - - 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 |
| - - deleted | 0..1 | Not Used | Boolean | If this item is actually marked as deleted Default Value: false |
| - - date | 0..1 | Required | dateTime | Who authored the comment on 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 Patient resource included in the list This MUST use the CareConnect patient profile. See Patient resource for information on how to populate the resource. |
| Not Used | Resource | |||
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL The reference to the included Patient resource. |
| - - - 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 |
| - emptyReason | 0..1 | Not Used | CodeableConcept | Why list is empty Binding (preferred): If a list is empty, why it is empty CareConnect-ListEmptyReasonCode-1 |
| - - 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 |
Mapping for Demographic History 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' |
| - 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. Common Languages |
| - 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 | 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 (patient-cadavericDonor) | 0..1 | Not Used | patient-cadavericDonor | 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 |
| - extension (residentialStatus) | 0..1 | Not Used | Extension-CareConnect-ResidentialStatus-1 | The residential status of the patient Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (treatmentCategory) | 0..1 | Not Used | Extension-CareConnect-TreatmentCategory-1 | The treatment category for this patient Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (nhsCommunication) | 0..* | Not Used | Extension-CareConnect-NHSCommunication-1 | NHS communication preferences for a resource Constraint (ext-1): Must have either extensions or value[x], not both |
| - 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 |
| - extension (nominatedPharmacy) | 0..1 | Not Used | Extension-CareConnect-NominatedPharmacy-1 | A patient’s nominated pharmacy Constraint (ext-1): Must have either extensions or value[x], not both |
| - extension (deathNotificationStatus) | 0..1 | Not Used | Extension-CareConnect-DeathNotificationStatus-1 | 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 |
| - 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..* | 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. |
| - - use | 0..1 | Not Used | Code | usual : official : temp : secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. IdentifierUse |
| - - 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. Identifier Type Codes |
| - - 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. |
| - - 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-Organization-1 | |||
| - 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. 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 |
| - - 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 |
| - name (other) | 0..* | Not Used | HumanName | A name associated with the patient |
| - - use | 1..1 | Not Used | Code | usual : official : temp : nickname : anonymous : old : maiden Binding (required): The use of a human name CareConnect-NameUse-1 |
| - - 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..* | 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) |
| - - 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 | 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' |
| - - extension (patient-birthTime) | 0..1 | Not Used | patient-birthTime | 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 |
| - 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 |
| - - type | 0..1 | Not Used | Code | postal : physical : both Binding (required): The type of an address (physical / postal) AddressType |
| - - text | 0..1 | Not Used | String | Text representation of the address |
| - - 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 |
| - - 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 | Required | String | Postal code for area Patient’s postcode PDS format |
| - - 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 | 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 |
| - - - version | 0..1 | Not Used | String | Version of the system - if relevant |
| - - - 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 |
| - - - 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 | Not Used | Boolean | Whether patient is part of a multiple birth |
| Not Used | Integer | |||
| - 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. MimeType |
| - - language | 0..1 | Not Used | Code | Human language of the content (BCP-47) Binding (extensible): A human language. Common Languages |
| - - 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. v2 Contact Role |
| - - - 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 : maiden Binding (required): The use of a human name NameUse |
| - - - 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 : other Binding (required): Telecommunications form for contact point ContactPointSystem |
| - - - 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 ContactPointUse |
| - - - 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 address Binding (required): The use of an address AddressUse |
| - - type | 0..1 | Not Used | Code | postal : physical : both Binding (required): The type of an address (physical / postal) AddressType |
| - - 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 : unknown Binding (required): The gender of a person used for administrative purposes. CareConnect-AdministrativeGender-1 |
| - - organization | 0..1 | Not Used | Reference | Organization that is associated with the contact Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-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 | 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 | Patient’s nominated primary care provider Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-1 | |||
| Not Used | CareConnect-Practitioner-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 |
| - managingOrganization | 0..1 | Not Used | Reference | Organization that is the custodian of the patient record Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Not Used | CareConnect-Organization-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 |
| - 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 | 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 |
| Not Used | RelatedPerson | |||
| Not Used | CareConnect-Patient-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 |
Patient Reference
The Admission details list has a mandated subject reference to the Patient resource. This means that any exchange of the Admission details heading data must also include the Patient demographics List.