Data mapping
This page defines how the data is mapped between relevant FHIR asset elements and the domain fields for ODS.
The relevant FHIR assets included in the mapping tables are Profiles 'UKCore-Organization', 'UKCore-OrganizationAffiliation', and associated Extensions usable for the ODS API. The domain fields are existing elements of data that will be shared with users of the ODS API solution.
All of the relevant elements for Profiles 'UKCore-Organization' and 'UKCore-OrganizationAffiliation', and relevant Extensions, are listed to illustrate that all of the domain fields for ODS are able to be mapped to existing Profiles and Extensions.
UKCore-Organization
| Element Name | Profile Cardinality | Domain Cardinality | Domain Optionality | Domain Field | Type | Definition, Constraints and Notes |
|---|---|---|---|---|---|---|
| extension (mainLocation) | 0..* | 0..* | Optional | Extension | ||
| extension (organization-period) | 0..1 | 0..1 | Optional | Extension | Use ExtensionEnglandTypedPeriod instead | |
| extension (ExtensionEnglandOrganisationRole) |
Not defined | 1..* |
Extension | |||
| ExtensionEnglandOrganisationRole. instanceID |
1..1 | 1..1 | NOT NULL | Roles.UniqueRoleID | Integer | |
| ExtensionEnglandOrganisationRole. roleCode |
1..1 | 1..1 | NOT NULL | Roles.RoleID | CodeableConcept | |
| ExtensionEnglandOrganisationRole. typedPeriod |
1..* | 1..* | NOT NULL | Roles.LegalStartDate, Roles.LegalEndDate, Roles.OperationalStartDate, Roles.OperationalEndDate |
Extension | |
| ExtensionEnglandOrganisationRole. active |
1..1 | 1..1 | NOT NULL | Roles.status | Boolean | |
| extension (ExtensionEnglandTypedDateTime) |
Not defined | 1..* |
NOT NULL | Organisation.LastChangeDate | Extension | |
| extension (ExtensionEnglandTypedPeriod) |
Not defined | 0..* |
Optional | Organisation.LegalStartDate, Organisation.LegalEndDate, Organisation.OperationalStartDate, Organisation.OperationalEndDate |
Extension | |
| identifier | 0..* | 1..1 |
NOT NULL | Organisation.OrganisationCode | Identifier | The ODS Organisation Code for the organisation SHALL be used to populate the odsOrganisationCode slice of the identifier element. |
| identifier.assigner.value | 0..* | 0..* | Optional | Organisation.AssigingAuthorityName | Reference | |
| active | 0..1 | 0..1 | Optional | Organisation.Status | ||
| type | 0..* | 2..* |
NOT NULL | Organisation.RefOnly, Organisation.RecordClass |
CodeableConcept | One each of: CodeSystem-England-ODSRecordClass CodeSystem-England-ODSRecordUseType |
| name | 0..1 | 1..1 |
NOT NULL | Organisation.Name | string | The name of the organisation SHALL be populated. |
| alias | 0..* | 0..* | Optional | string | ||
| telecom | 0..* | 0..* | Optional | Organisation.TelephoneNumber, Organisation.HTTP | ContactPoint | Telephone number is nullified for RefOnly/skeleton records. system='phone' and system='url' |
| address | 0..* | 0..* | Optional | Location.AddrLn1 Location.AddrLn2 Location.AddrLn3 Location.Town Location.County Location.Postcode |
Address | |
| address.extension (ExtensionUKCoreAddressKey) | Not defined | 0..* | Optional | Location.URPN | Extension | |
| partOf | 0..1 | 0..1 | Optional | Reference | Use OrganizationAffiliation instead | |
| contact | 0..* | 0..* | Optional | BackboneElement | ||
| endpoint | 0..* | 0..* | Optional | Reference |
UKCore-OrganizationAffiliation
| Element Name | Profile Cardinality | Domain Cardinality | Domain Optionality | Domain Field | Type | Definition, Constraints and Notes |
|---|---|---|---|---|---|---|
| extension (ExtensionEnglandTypedPeriod) | Not defined | 0..* |
Optional | rel.LegalStart, rel.LegalEnd, rel.OperationalStart, rel.OperationalEnd |
Extension | |
| identifier | 0..* | 1..1 |
NOT NULL | rel.UniqueRelID | Identifier | |
| active | 0..1 | 1..1 |
NOT NULL | rel.Status | boolean | Set to active/inactive based on both date concepts |
| period | 0..1 | 0..1 | Optional | period | Use ExtensionEnglandTypedPeriod instead | |
| organization | 0..1 | 1..1 |
NOT NULL | Organisation Identifier | Reference | |
| participatingOrganization | 0..1 | 1..1 |
NOT NULL | rel.TargetOrgID | Reference | |
| network | 0..* | 0..* | Optional | Reference | ||
| code | 0..* | 1..1 |
NOT NULL | rel.TypeID / rel.TypeName | CodeableConcept | CodeSystem-England-ODSRelationship |
| specialty | 0..* | 0..* | Optional | CodeableConcept | ||
| location | 0..* | 0..* | Optional | Reference | ||
| healthcareService | 0..* | 0..* | Optional | Reference | ||
| telecom | 0..* | 0..* | Optional | ContactPoint | ||
| endpoint | 0..* | 0..* | Optional | Reference |