Organisation Reference Data (ORD)
User stories
- Data Manager
- Clinical Systems Developer
- Commissioner
- Head Clinician
- Data Consumer
- National Payments System
Data Manager
As a Data Manager:
- I need access to a single source of data, so that I can assure that the information sourced is correct.
- I need to bring data together from different sources, so that I get meaningful insights to improve patient care and drive change.
- I need help deciding if the API is right for me, so that I get resources or use alternative methods.
- I need to understand at a glance what fields are called, so that I can save time and confusion.
- I need data on a regular basis (at least monthly), so that I can create reports that are up to date.
- I need clearer definitions of roles and relationships so that my reports can track which organisations are operated, commissioned, directed etc and understand impacts of mergers.
Use Case Flows
Actors
- Data Managers
- Data Analysts
Frequency of Use
- Daily, Weekly, Monthly
Triggers
- Reporting requirements
Pre-conditions
- Access to clear documentation on how to access and call the API.
- Accurate and contemporaneous data available.
- The Data Consumer's system is functional and has required space and mechanisms available for data import.
Post-conditions
- Database is populated with data from ODS.
- Reports created and run.
- Data integrated into data visualisation tools such as Power BI.
Main Course
- Send a request to ODS API for required data.
- ODS API processes the request and initiates the data transfer.
- Receive and store data in database.
- Parse and validate the data.
- If any data mismatches or errors are found, they will be logged for further review and action.
Alternative Course
- If the initial data request is denied or doesn't go through due to issues like network problems or system failure, there must be a mechanism set in place to retry the request after a specific timeframe.
- Data can be manually updated in the directory to match what is published in the ODS database if needed.
Exception
- If the ODS API is not accessible or new data is not available, the issue should be logged and attempt to connect again after a specific interval.
Clinical Systems Developer
As a Clinical Systems Developer:
- I need a persistent organisation code identifier, so that I can be confident in the data I integrate to downstream systems.
- I need a FHIR API, so that I can more easily integrate the data with other NHS systems.
- I need to have access to good technical documentation, so that I can assess if the API is applicable for us and how it works.
- I need clearer signposting to clearer information, so that I can save time.
- I need easy access to relationship data, so that I can be confident that commissioning outcomes are correct.
- I need to query intersections of organisation and geographical boundaries so that I can query for all the GP Practices in a statistical geography e.g., local authority.
Use Case Flows
Actors
- Clinical Systems Developer
Frequency of Use
- Daily, Weekly, Monthly
Triggers
- Integration with downstream systems.
Pre-conditions
- The ODS API is stable and populated with correct data.
- Information on the data model and schemas is available.
- Good technical documentation is available.
Post-conditions
- Data is sent to downstream systems.
- Data integrity checks.
Main Course
- Write code for making scheduled calls to the API.
- Write code to integrate ODS data with downstream systems.
Alternative Course
- If the initial data request is denied or doesn't go through due to issues like network problems or system failure, there must be a mechanism set in place to retry the request after a specific timeframe.
- Data can be manually updated in the directory to match what is published in the ODS database if needed.
Exception
- If the ODS API is not accessible or new data is not available, the issue should be logged and attempt to connect again after a specific interval.
Commissioner
As a Clinical Commissioner:
- I need access to a single source of data, so that I can have complete confidence that the data is consistent and contemporaneous.
- I need to know where the data comes from and when it was last changed, so that I no longer have to call to check or do extra work to verify data (last change data).
- I need to be able to take data from one system and use it in another easily, so that I can save time cleaning and reformatting the data.
- I need to have an easy 'look up' tool for codes – or to be able to tell at a glance what a code is for, so that I can check organisation codes don't already exist if I think I need a new one.
- I need clear information on how to use the API, so that I can use it effectively.
Use Case Flows
Actors
- Commissioners
Frequency of Use
- Daily, Weekly, Monthly
Triggers
- Payment requirements.
Pre-conditions
- The payment system directory is updated with the new data from ODS.
- Payments are calculated and sent for processing.
- The system is ready for the next update from the ODS API
Post-conditions
- The payment system directory is updated with the new data from ODS.
- Payments are calculated and sent for processing.
- The system is ready for the next update from the ODS API.
Main Course
- Payment System sends a request to ODS API to check for new/amended data.
- If new data is available, Payment System sends a request to import the new data.
- ODS API processes the request and initiates the data transfer.
- Payment System receives and stores the new data.
- Payment System will then parse and validate the new data.
- If any data mismatches or errors are found, they will be logged for further review and action.
Alternative Course
- If the initial data request is denied or doesn't go through due to issues like network problems or system failure, there must be a mechanism set in place to retry the request after a specific timeframe.
- Data can be manually updated in the directory to match what is published in the ODS database if needed.
Exception
- If the ODS API is not accessible or new data is not available, the issue should be logged and attempt to connect again after a specific interval.
Head Clinician
As a Head Clinician:
- I need a persistent identifier, or unambiguous data, so that I can keep track of how well services are performing.
- I need to match ODS codes to people, so that I can say ‘Dr X’ works at this practice – trends and patterns linked to Clinicians.
- I need to compare geographic data, so that I can look into variations of patient care and reduce 'postcode lottery', compare Practices and Trusts.
- I need to be able to spot patterns and trends in aggregated data, so that we can accelerate improvements to patient care.
- I need to be able to visualise data, so that I can more quickly spot trends or anomalies.
Use Case Flows
Actors
- Technically skilled clinicians
Frequency of Use
- Daily
Triggers
- Data for research and forecasting.
Pre-conditions
- The ODS API is stable and populated with correct data.
- Information on the data model and schemas is available.
- Relationship, location, and organisation data is readily available.
- Data is in interoperable formats.
- Good technical documentation is available.
Post-conditions
- Systems are updated with ODS data.
- Systems data can integrate with upstream systems for research, forecasting and modelling purposes.
Main Course
- Request sent to ODS API(s) for data.
- ODS API should authenticate the user.
- ODS API acknowledges and processes the request and initiates the data transfer.
- ODS data is received and integrated with our systems.
Alternative Course
- If the initial data request is denied or doesn't go through due to issues like network problems or system failure, there must be a mechanism set in place to retry the request after a specific timeframe.
- Data can be manually updated in the directory to match what is published in the ODS database if needed.
Exception
- If the ODS API is not accessible or new data is not available, the issue should be logged and attempt to connect again after a specific interval.
Data Consumer
As a Data Consumer:
- I need access to a single source of data, so that I can ensure that the information sourced is correct..
- I need to query for recent changes so I can update my directory in an efficient manner without needing to sync the whole unchanged dataset.
- I need help deciding if the API is right for me, so that I get resources or use alternative methods.
- I need to understand at a glance what fields are called, so that I can save time and confusion when importing the data into the directory.
- I need data on a regular basis (at least daily), so that the directory is always up to date.
- I need clearer definitions of roles and relationships so that my directory can create a hierarchy of parent/child relationships between organisations.
Use Case Flows
Actors
- Data Consumer
Frequency of Use
- Daily
Triggers
- Data source updates.
Pre-conditions
- The Data Consumer has the necessary clearance and permissions to access the ODS API.
- The ODS API must be accessible to the Data Consumer.
- The ODS API should have the required and up-to-date data available.
- The Data Consumer's system is functional and has the required space and mechanisms available for data import.
Post-conditions
- The Data Consumer's directory is updated with the new data from ODS.
- In case of any data mismatches or errors during the import process, they should be logged and corrective actions need to be taken.
- The system is ready for the next update from the ODS API.
Main Course
- Data Consumer sends a request to ODS API to check for new data.
- ODS API authenticates and authorizes the Data Consumer.
- ODS API sends a response indicating whether there's new data available.
- If new data is available, Data Consumer sends a request to import the new data.
- ODS API processes the request and initiates the data transfer.
- Data Consumer receives and stores the new data in the directory.
- Data Consumer will then parse and validate the new data.
- If any data mismatches or errors are found, they will be logged for further review and action.
Alternative Course
- If the initial data request from the Data Consumer is denied or doesn't go through due to issues like network problems or system failure, the data consumer must have a mechanism set in place to retry the request after a specific timeframe.
- Data can be manually updated in the directory to match what is published in the ODS database if needed.
Exception
- If the ODS API is not accessible or new data is not available, the Data Consumer should log the issue and attempt to connect again after a specific interval.
National Payments System
As a National Payments System:
- I need to obtain an accurate list of PCNs (Primary Care Networks) so that I can instigate payment processes for those entities
- I need to identify which GP practices are partner to which PCN with associated dates, so that I can use the data to calculate the level of payment due to each PCN
- I need to obtain confirmation of who the commissioner is for the PCN, so that I can ensure payments are made from the correct budget
- I need to be able to identify who the nominated payee is for the PCN, so that payments can be made to the correct bank accounts
- I need PCN relationship data to be reliable and timely, so that payments are made correctly
Use Case Flows
Actors
- Technical/Solutions Architects and System Developers
Frequency of Use
- Daily
Triggers
- Payment requirements.
Pre-conditions
- The ODS API must be accessible to the Payment System
- The ODS API should have the required and up-to-date data available
- The payment system is functional and has required space and mechanisms available for data import
- Every PCN has an ODS code and associated reference data
Post-conditions
- The payment system directory is updated with the new data from ODS
- In case of any data mismatches or errors during the import process, they should be logged and corrective actions need to be taken
- PCN payments calculated and sent for processing
- The system is ready for the next update from the ODS API
Main Course
- Payment System sends a request to ODS API to check for new/amended data
- ODS API sends a response indicating whether there's new data available
- If new data is available, Payment System sends a request to import the new data
- ODS API processes the request and initiates the data transfer
- Payment System receives and stores the new data in the directory
- Payment System will then parse and validate the new data
- If any data mismatches or errors are found, they will be logged for further review and action
Alternative Course
- If the initial data request from the Payment System is denied or doesn't go through due to issues like network problems or system failure, the Payment System must have a mechanism set in place to retry the request after a specific timeframe
- Data can be manually updated in the directory to match what is published in the ODS database if needed
Exception
- If the ODS API is not accessible or new data is not available, the Payment System should log the issue and attempt to connect again after a specific interval
FHIR Assets for Sprint 2
England ORD Date Time
Description |
---|
A set of codes that define the type of Organisation Reference Data (ORD) date and time being recorded, for the Organisation Data Service (ODS). |
HTML View
Table View
CodeSystem.id[0] | England-ORDDateTime |
CodeSystem.url[0] | https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime |
CodeSystem.version[0] | 1.0.0 |
CodeSystem.name[0] | EnglandORDDateTime |
CodeSystem.title[0] | England ORD Date Time |
CodeSystem.status[0] | draft |
CodeSystem.date[0] | 2023-10-24 |
CodeSystem.publisher[0] | NHS England |
CodeSystem.contact[0].name[0] | NHS England |
CodeSystem.contact[0].telecom[0].system[0] | |
CodeSystem.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CodeSystem.contact[0].telecom[0].use[0] | work |
CodeSystem.contact[0].telecom[0].rank[0] | 1 |
CodeSystem.description[0] | A set of codes that define the type of Organisation Reference Data (ORD) date and time being recorded, for the Organisation Data Service (ODS). |
CodeSystem.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CodeSystem.caseSensitive[0] | True |
CodeSystem.content[0] | complete |
CodeSystem.concept[0].code[0] | last-change-date |
CodeSystem.concept[0].display[0] | Last Change Date |
CodeSystem.concept[0].definition[0] | The date and time that the ORD data was last changed |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="England-ORDDateTime" /> <url value="https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime" /> <version value="1.0.0" /> <name value="EnglandORDDateTime" /> <title value="England ORD Date Time" /> <status value="draft" /> <date value="2023-10-24" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A set of codes that define the type of Organisation Reference Data (ORD) date and time being recorded, for the Organisation Data Service (ODS)." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <caseSensitive value="true" /> <content value="complete" /> <concept> <code value="last-change-date" /> <display value="Last Change Date" /> <definition value="The date and time that the ORD data was last changed" /> </concept> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "England-ORDDateTime", "url": "https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime", "version": "1.0.0", "name": "EnglandORDDateTime", "title": "England ORD Date Time", "status": "draft", "date": "2023-10-24", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A set of codes that define the type of Organisation Reference Data (ORD) date and time being recorded, for the Organisation Data Service (ODS).", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "caseSensitive": true, "content": "complete", "concept": [ { "code": "last-change-date", "display": "Last Change Date", "definition": "The date and time that the ORD data was last changed" } ] }
England ORD Organisation Role
Description |
---|
A set of codes that define the high level roles that may be related to individual Organisations or ODS Sites. For more information and an up to date list see: Organisation Data Service CodeSet. |
HTML View
This code system https://ord.nhs.uk/CodeSystem/role defines many codes, but they are not represented here
Table View
CodeSystem.id[0] | England-ORDOrganisationRole |
CodeSystem.url[0] | https://ord.nhs.uk/CodeSystem/role |
CodeSystem.version[0] | 1.0.0 |
CodeSystem.name[0] | EnglandORDOrganisationRole |
CodeSystem.title[0] | England ORD Organisation Role |
CodeSystem.status[0] | draft |
CodeSystem.date[0] | 2023-11-16 |
CodeSystem.publisher[0] | NHS England |
CodeSystem.contact[0].name[0] | NHS England |
CodeSystem.contact[0].telecom[0].system[0] | |
CodeSystem.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CodeSystem.contact[0].telecom[0].use[0] | work |
CodeSystem.contact[0].telecom[0].rank[0] | 1 |
CodeSystem.contact[1].name[0] | Organisation Data Service |
CodeSystem.contact[1].telecom[0].system[0] | |
CodeSystem.contact[1].telecom[0].value[0] | exeter.helpdesk@nhs.net |
CodeSystem.contact[1].telecom[0].use[0] | work |
CodeSystem.contact[1].telecom[0].rank[0] | 1 |
CodeSystem.description[0] | A set of codes that define the high level roles that may be related to individual Organisations or ODS Sites. For more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems). |
CodeSystem.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CodeSystem.content[0] | not-present |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="England-ORDOrganisationRole" /> <url value="https://ord.nhs.uk/CodeSystem/role" /> <version value="1.0.0" /> <name value="EnglandORDOrganisationRole" /> <title value="England ORD Organisation Role" /> <status value="draft" /> <date value="2023-11-16" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="Organisation Data Service" /> <telecom> <system value="email" /> <value value="exeter.helpdesk@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A set of codes that define the high level roles that may be related to individual Organisations or ODS Sites.\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems)." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <content value="not-present" /> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "England-ORDOrganisationRole", "url": "https://ord.nhs.uk/CodeSystem/role", "version": "1.0.0", "name": "EnglandORDOrganisationRole", "title": "England ORD Organisation Role", "status": "draft", "date": "2023-11-16", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] }, { "name": "Organisation Data Service", "telecom": [ { "system": "email", "value": "exeter.helpdesk@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A set of codes that define the high level roles that may be related to individual Organisations or ODS Sites.\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems).", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "content": "not-present" }
England ORD Record Class
Description |
---|
A set of codes that define the high level type / class of record published by Organisation Data Service (ODS). For more information and an up to date list see: Organisation Data Service CodeSet. |
HTML View
This code system https://ord.nhs.uk/CodeSystem/record-class defines many codes, but they are not represented here
Table View
CodeSystem.id[0] | England-ORDRecordClass |
CodeSystem.url[0] | https://ord.nhs.uk/CodeSystem/record-class |
CodeSystem.version[0] | 1.0.0 |
CodeSystem.name[0] | EnglandORDRecordClass |
CodeSystem.title[0] | England ORD Record Class |
CodeSystem.status[0] | draft |
CodeSystem.date[0] | 2023-11-16 |
CodeSystem.publisher[0] | NHS England |
CodeSystem.contact[0].name[0] | NHS England |
CodeSystem.contact[0].telecom[0].system[0] | |
CodeSystem.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CodeSystem.contact[0].telecom[0].use[0] | work |
CodeSystem.contact[0].telecom[0].rank[0] | 1 |
CodeSystem.contact[1].name[0] | Organisation Data Service |
CodeSystem.contact[1].telecom[0].system[0] | |
CodeSystem.contact[1].telecom[0].value[0] | exeter.helpdesk@nhs.net |
CodeSystem.contact[1].telecom[0].use[0] | work |
CodeSystem.contact[1].telecom[0].rank[0] | 1 |
CodeSystem.description[0] | A set of codes that define the high level type / class of record published by Organisation Data Service (ODS). For more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems). |
CodeSystem.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CodeSystem.content[0] | not-present |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="England-ORDRecordClass" /> <url value="https://ord.nhs.uk/CodeSystem/record-class" /> <version value="1.0.0" /> <name value="EnglandORDRecordClass" /> <title value="England ORD Record Class" /> <status value="draft" /> <date value="2023-11-16" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="Organisation Data Service" /> <telecom> <system value="email" /> <value value="exeter.helpdesk@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A set of codes that define the high level type / class of record published by Organisation Data Service (ODS).\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems)." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <content value="not-present" /> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "England-ORDRecordClass", "url": "https://ord.nhs.uk/CodeSystem/record-class", "version": "1.0.0", "name": "EnglandORDRecordClass", "title": "England ORD Record Class", "status": "draft", "date": "2023-11-16", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] }, { "name": "Organisation Data Service", "telecom": [ { "system": "email", "value": "exeter.helpdesk@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A set of codes that define the high level type / class of record published by Organisation Data Service (ODS).\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems).", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "content": "not-present" }
England ORD Record Use Type
Description |
---|
A set of codes that define the intended use of a record within the Organisation Data Services (ODS). Full records are complete, whereas skeleton/partial records are provided for reference use only. Record use type is distinct from Status and Record Class. For more information and an up to date list see: Organisation Data Service CodeSet. |
HTML View
This code system https://ord.nhs.uk/CodeSystem/record-class defines many codes, but they are not represented here
Table View
CodeSystem.id[0] | England-ORDRecordClass |
CodeSystem.url[0] | https://ord.nhs.uk/CodeSystem/record-class |
CodeSystem.version[0] | 1.0.0 |
CodeSystem.name[0] | EnglandORDRecordClass |
CodeSystem.title[0] | England ORD Record Class |
CodeSystem.status[0] | draft |
CodeSystem.date[0] | 2023-11-16 |
CodeSystem.publisher[0] | NHS England |
CodeSystem.contact[0].name[0] | NHS England |
CodeSystem.contact[0].telecom[0].system[0] | |
CodeSystem.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CodeSystem.contact[0].telecom[0].use[0] | work |
CodeSystem.contact[0].telecom[0].rank[0] | 1 |
CodeSystem.contact[1].name[0] | Organisation Data Service |
CodeSystem.contact[1].telecom[0].system[0] | |
CodeSystem.contact[1].telecom[0].value[0] | exeter.helpdesk@nhs.net |
CodeSystem.contact[1].telecom[0].use[0] | work |
CodeSystem.contact[1].telecom[0].rank[0] | 1 |
CodeSystem.description[0] | A set of codes that define the high level type / class of record published by Organisation Data Service (ODS). For more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems). |
CodeSystem.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CodeSystem.content[0] | not-present |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="England-ORDRecordClass" /> <url value="https://ord.nhs.uk/CodeSystem/record-class" /> <version value="1.0.0" /> <name value="EnglandORDRecordClass" /> <title value="England ORD Record Class" /> <status value="draft" /> <date value="2023-11-16" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="Organisation Data Service" /> <telecom> <system value="email" /> <value value="exeter.helpdesk@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A set of codes that define the high level type / class of record published by Organisation Data Service (ODS).\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems)." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <content value="not-present" /> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "England-ORDRecordClass", "url": "https://ord.nhs.uk/CodeSystem/record-class", "version": "1.0.0", "name": "EnglandORDRecordClass", "title": "England ORD Record Class", "status": "draft", "date": "2023-11-16", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] }, { "name": "Organisation Data Service", "telecom": [ { "system": "email", "value": "exeter.helpdesk@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A set of codes that define the high level type / class of record published by Organisation Data Service (ODS).\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems).", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "content": "not-present" }
England ORD Relationship
Description |
---|
A set of codes that define the type of relationships which are allowed between Organisation or Site entities/records using the Organisation Data Service (ODS). For more information and an up to date list see: Organisation Data Service CodeSet. |
HTML View
This code system https://ord.nhs.uk/CodeSystem/relationship defines many codes, but they are not represented here
Table View
CodeSystem.id[0] | England-ORDRelationship |
CodeSystem.url[0] | https://ord.nhs.uk/CodeSystem/relationship |
CodeSystem.version[0] | 1.0.0 |
CodeSystem.name[0] | EnglandORDRelationship |
CodeSystem.title[0] | England ORD Relationship |
CodeSystem.status[0] | draft |
CodeSystem.date[0] | 2023-11-16 |
CodeSystem.publisher[0] | NHS England |
CodeSystem.contact[0].name[0] | NHS England |
CodeSystem.contact[0].telecom[0].system[0] | |
CodeSystem.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CodeSystem.contact[0].telecom[0].use[0] | work |
CodeSystem.contact[0].telecom[0].rank[0] | 1 |
CodeSystem.contact[1].name[0] | Organisation Data Service |
CodeSystem.contact[1].telecom[0].system[0] | |
CodeSystem.contact[1].telecom[0].value[0] | exeter.helpdesk@nhs.net |
CodeSystem.contact[1].telecom[0].use[0] | work |
CodeSystem.contact[1].telecom[0].rank[0] | 1 |
CodeSystem.description[0] | A set of codes that define the type of relationships which are allowed between Organisation or Site entities/records using the Organisation Data Service (ODS). For more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems). |
CodeSystem.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CodeSystem.content[0] | not-present |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="England-ORDRelationship" /> <url value="https://ord.nhs.uk/CodeSystem/relationship" /> <version value="1.0.0" /> <name value="EnglandORDRelationship" /> <title value="England ORD Relationship" /> <status value="draft" /> <date value="2023-11-16" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <contact> <name value="Organisation Data Service" /> <telecom> <system value="email" /> <value value="exeter.helpdesk@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A set of codes that define the type of relationships which are allowed between Organisation or Site entities/records using the Organisation Data Service (ODS).\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems)." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <content value="not-present" /> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "England-ORDRelationship", "url": "https://ord.nhs.uk/CodeSystem/relationship", "version": "1.0.0", "name": "EnglandORDRelationship", "title": "England ORD Relationship", "status": "draft", "date": "2023-11-16", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] }, { "name": "Organisation Data Service", "telecom": [ { "system": "email", "value": "exeter.helpdesk@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A set of codes that define the type of relationships which are allowed between Organisation or Site entities/records using the Organisation Data Service (ODS).\n\nFor more information and an up to date list see: [Organisation Data Service CodeSet](https://digital.nhs.uk/services/organisation-data-service/codesystems).", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "content": "not-present" }
England Period Type
Description |
---|
A set of codes that define and identify the type of time period data being recorded. Initial codes populated from ORD use case to record legal and operational periods. |
HTML View
Table View
CodeSystem.id[0] | England-PeriodType |
CodeSystem.url[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
CodeSystem.version[0] | 1.0.0 |
CodeSystem.name[0] | EnglandPeriodType |
CodeSystem.title[0] | England Period Type |
CodeSystem.status[0] | draft |
CodeSystem.date[0] | 2023-10-13 |
CodeSystem.publisher[0] | NHS England |
CodeSystem.contact[0].name[0] | NHS England |
CodeSystem.contact[0].telecom[0].system[0] | |
CodeSystem.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
CodeSystem.contact[0].telecom[0].use[0] | work |
CodeSystem.contact[0].telecom[0].rank[0] | 1 |
CodeSystem.description[0] | A set of codes that define and identify the type of time period data being recorded. Initial codes populated from ORD use case to record legal and operational periods. |
CodeSystem.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
CodeSystem.caseSensitive[0] | True |
CodeSystem.content[0] | complete |
CodeSystem.concept[0].code[0] | legal |
CodeSystem.concept[0].display[0] | Legal |
CodeSystem.concept[1].code[0] | operational |
CodeSystem.concept[1].display[0] | Operational |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="England-PeriodType" /> <url value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <version value="1.0.0" /> <name value="EnglandPeriodType" /> <title value="England Period Type" /> <status value="draft" /> <date value="2023-10-13" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A set of codes that define and identify the type of time period data being recorded. Initial codes populated from ORD use case to record legal and operational periods." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <caseSensitive value="true" /> <content value="complete" /> <concept> <code value="legal" /> <display value="Legal" /> </concept> <concept> <code value="operational" /> <display value="Operational" /> </concept> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "England-PeriodType", "url": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "version": "1.0.0", "name": "EnglandPeriodType", "title": "England Period Type", "status": "draft", "date": "2023-10-13", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A set of codes that define and identify the type of time period data being recorded. Initial codes populated from ORD use case to record legal and operational periods.", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "caseSensitive": true, "content": "complete", "concept": [ { "code": "legal", "display": "Legal" }, { "code": "operational", "display": "Operational" } ] }
StructureDefinition Extension-England-DateTime
Canonical_URL | Description | Profile_Purpose |
---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime | This supports the exchange of non-clinical business dates and times. The extension date and/or time is carried along with a code to identify the type of date and/or time. | This extension extends the Encounter, the Communication, the Organization and the OrganizationAffiliation resources to support the exchange of information describing the specific business related date and/or time. |
Context of Use: | Organization, OrganizationAffiliation |
Tree View
Table View
Extension | .. | |
Extension.extension | 2.. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | Coding | 1.. |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | dateTime | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-England-DateTime" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime" /> <version value="1.0.0" /> <name value="ExtensionEnglandDateTime" /> <title value="Extension England Date Time" /> <status value="draft" /> <date value="2023-10-24" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This supports the exchange of non-clinical business dates and times. The extension date and/or time is carried along with a code to identify the type of date and/or time." /> <purpose value="This extension extends the Encounter, the Communication, the Organization and the OrganizationAffiliation resources to support the exchange of information describing the specific business related date and/or time." /> <copyright value="Copyright © 2023+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Organization" /> </context> <context> <type value="element" /> <expression value="OrganizationAffiliation" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="This supports the exchange of dates and/or times." /> <definition value="This supports the exchange of dates and/or times. The extension date and/or time is carried along with a code to identify the type of date and/or time." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <min value="2" /> </element> <element id="Extension.extension:type"> <path value="Extension.extension" /> <sliceName value="type" /> <short value="Code to identify the type of time/date." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:type.url"> <path value="Extension.extension.url" /> <fixedUri value="type" /> </element> <element id="Extension.extension:type.value[x]"> <path value="Extension.extension.value[x]" /> <short value="A ValueSet to identify the type of business date time." /> <min value="1" /> <type> <code value="Coding" /> </type> <binding> <strength value="extensible" /> <description value="The type of business date time." /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime" /> </binding> </element> <element id="Extension.extension:dateTime"> <path value="Extension.extension" /> <sliceName value="dateTime" /> <short value="The specific business related date and/or time." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:dateTime.url"> <path value="Extension.extension.url" /> <fixedUri value="dateTime" /> </element> <element id="Extension.extension:dateTime.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The date and/or time." /> <min value="1" /> <type> <code value="dateTime" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-England-DateTime", "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime", "version": "1.0.0", "name": "ExtensionEnglandDateTime", "title": "Extension England Date Time", "status": "draft", "date": "2023-10-24", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "This supports the exchange of non-clinical business dates and times. The extension date and/or time is carried along with a code to identify the type of date and/or time.", "purpose": "This extension extends the Encounter, the Communication, the Organization and the OrganizationAffiliation resources to support the exchange of information describing the specific business related date and/or time.", "copyright": "Copyright © 2023+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Organization" }, { "type": "element", "expression": "OrganizationAffiliation" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "This supports the exchange of dates and/or times.", "definition": "This supports the exchange of dates and/or times. The extension date and/or time is carried along with a code to identify the type of date and/or time." }, { "id": "Extension.extension", "path": "Extension.extension", "min": 2 }, { "id": "Extension.extension:type", "path": "Extension.extension", "sliceName": "type", "short": "Code to identify the type of time/date.", "min": 1, "max": "1" }, { "id": "Extension.extension:type.url", "path": "Extension.extension.url", "fixedUri": "type" }, { "id": "Extension.extension:type.value[x]", "path": "Extension.extension.value[x]", "short": "A ValueSet to identify the type of business date time.", "min": 1, "type": [ { "code": "Coding" } ], "binding": { "strength": "extensible", "description": "The type of business date time.", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime" } }, { "id": "Extension.extension:dateTime", "path": "Extension.extension", "sliceName": "dateTime", "short": "The specific business related date and/or time.", "min": 1, "max": "1" }, { "id": "Extension.extension:dateTime.url", "path": "Extension.extension.url", "fixedUri": "dateTime" }, { "id": "Extension.extension:dateTime.value[x]", "path": "Extension.extension.value[x]", "short": "The date and/or time.", "min": 1, "type": [ { "code": "dateTime" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-DateTime" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
None provided at this time.Extension Specific Guidance
There is a binding within this extension to ValueSet-England-TypedDateTimeStructureDefinition Extension-England-OrganisationRole
Canonical_URL | Description | Profile_Purpose |
---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole | An extension to describe the role of the organisation. | This extension extends the Organization resource to support the NHS England requirement for additional information about organisational roles. |
Context of Use: | Organization, OrganizationAffiliation |
Tree View
Extension | I | Extension | |
extension | I | 4..* | Extension |
instanceID | I | 1..1 | Extension |
url | 1..1 | System.StringFixed Value | |
value[x] | 1..1 | ||
valueInteger | integer | ||
roleCode | I | 1..1 | ExtensionBinding |
url | 1..1 | System.StringFixed Value | |
value[x] | 1..1 | ||
valueCodeableConcept | CodeableConcept | ||
coding | Σ | 0..* | Coding |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
typedPeriod | I | 1..* | Extension(Complex) |
extension | I | 2..* | Extension |
dateType | I | 1..1 | Extension |
url | 1..1 | System.StringFixed Value | |
value[x] | 1..1 | Binding | |
valueCoding | Coding | ||
period | I | 1..1 | Extension |
url | 1..1 | System.StringFixed Value | |
value[x] | 1..1 | ||
valuePeriod | Period | ||
url | 1..1 | System.StringFixed Value | |
value[x] | 0..0 | ||
active | I | 1..1 | Extension |
url | 1..1 | System.StringFixed Value | |
value[x] | 1..1 | ||
valueBoolean | boolean | ||
url | 1..1 | System.StringFixed Value | |
value[x] | 0..0 |
Table View
Extension | .. | |
Extension.extension | 4.. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | integer | 1.. |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | CodeableConcept | 1.. |
Extension.extension.value[x].coding | .. | |
Extension.extension.value[x].coding.code | 1.. | |
Extension.extension | Extension | 1.. |
Extension.extension.url | .. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | boolean | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-England-OrganisationRole" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" /> <version value="1.0.0" /> <name value="ExtensionEnglandOrganisationRole" /> <title value="Extension England Organisation Role" /> <status value="draft" /> <date value="2023-10-18" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="An extension to describe the role of the organisation." /> <purpose value="This extension extends the Organization resource to support the NHS England requirement for additional information about organisational roles." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Organization" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="An Extension to describe what an Organisation does." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <min value="4" /> </element> <element id="Extension.extension:instanceID"> <path value="Extension.extension" /> <sliceName value="instanceID" /> <short value="Unique ID for each instance of an organisation role (organisation roles can be ended and then the organisation later undertakes same role again)." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:instanceID.url"> <path value="Extension.extension.url" /> <fixedUri value="instanceID" /> </element> <element id="Extension.extension:instanceID.value[x]"> <path value="Extension.extension.value[x]" /> <min value="1" /> <type> <code value="integer" /> </type> </element> <element id="Extension.extension:roleCode"> <path value="Extension.extension" /> <sliceName value="roleCode" /> <min value="1" /> <max value="1" /> <binding> <strength value="extensible" /> <description value="A ValueSet to identify the organisation role codes" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole" /> </binding> </element> <element id="Extension.extension:roleCode.url"> <path value="Extension.extension.url" /> <fixedUri value="roleCode" /> </element> <element id="Extension.extension:roleCode.value[x]"> <path value="Extension.extension.value[x]" /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> </element> <element id="Extension.extension:roleCode.value[x].coding.code"> <path value="Extension.extension.value[x].coding.code" /> <min value="1" /> </element> <element id="Extension.extension:typedPeriod"> <path value="Extension.extension" /> <sliceName value="typedPeriod" /> <short value="Period of the role" /> <min value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" /> </type> </element> <element id="Extension.extension:typedPeriod.url"> <path value="Extension.extension.url" /> <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" /> </element> <element id="Extension.extension:active"> <path value="Extension.extension" /> <sliceName value="active" /> <short value="Roles are either active or inactive" /> <definition value="Where the Boolean value is true, this means that the role is active. Conversely if the Boolean value is false, then this means that the role is inactive." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:active.url"> <path value="Extension.extension.url" /> <fixedUri value="active" /> </element> <element id="Extension.extension:active.value[x]"> <path value="Extension.extension.value[x]" /> <min value="1" /> <type> <code value="boolean" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-England-OrganisationRole", "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole", "version": "1.0.0", "name": "ExtensionEnglandOrganisationRole", "title": "Extension England Organisation Role", "status": "draft", "date": "2023-10-18", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "An extension to describe the role of the organisation.", "purpose": "This extension extends the Organization resource to support the NHS England requirement for additional information about organisational roles.", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Organization" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "An Extension to describe what an Organisation does." }, { "id": "Extension.extension", "path": "Extension.extension", "min": 4 }, { "id": "Extension.extension:instanceID", "path": "Extension.extension", "sliceName": "instanceID", "short": "Unique ID for each instance of an organisation role (organisation roles can be ended and then the organisation later undertakes same role again).", "min": 1, "max": "1" }, { "id": "Extension.extension:instanceID.url", "path": "Extension.extension.url", "fixedUri": "instanceID" }, { "id": "Extension.extension:instanceID.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "integer" } ] }, { "id": "Extension.extension:roleCode", "path": "Extension.extension", "sliceName": "roleCode", "min": 1, "max": "1", "binding": { "strength": "extensible", "description": "A ValueSet to identify the organisation role codes", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole" } }, { "id": "Extension.extension:roleCode.url", "path": "Extension.extension.url", "fixedUri": "roleCode" }, { "id": "Extension.extension:roleCode.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "CodeableConcept" } ] }, { "id": "Extension.extension:roleCode.value[x].coding.code", "path": "Extension.extension.value[x].coding.code", "min": 1 }, { "id": "Extension.extension:typedPeriod", "path": "Extension.extension", "sliceName": "typedPeriod", "short": "Period of the role", "min": 1, "type": [ { "code": "Extension", "profile": [ "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" ] } ] }, { "id": "Extension.extension:typedPeriod.url", "path": "Extension.extension.url", "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" }, { "id": "Extension.extension:active", "path": "Extension.extension", "sliceName": "active", "short": "Roles are either active or inactive", "definition": "Where the Boolean value is true, this means that the role is active. Conversely if the Boolean value is false, then this means that the role is inactive.", "min": 1, "max": "1" }, { "id": "Extension.extension:active.url", "path": "Extension.extension.url", "fixedUri": "active" }, { "id": "Extension.extension:active.value[x]", "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "boolean" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
None provided at this time.Extension Specific Guidance
There is a binding within this extension to ValueSet-England-OrganisationRoleStructureDefinition Extension-England-TypedPeriod
Canonical_URL | Description | Profile_Purpose |
---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod | This supports the exchange of time periods. The extension time period is carried along with a code to identify whether the data is recorded for legal or operational periods. | This extension has been created from an ORD use-case in which there is a requirement to hold data for Legal and Operational dates, although it is expected to be broader than ORD and can be used for other scenarios. |
Context of Use: | Organization, OrganizationAffiliation, ExtensionEnglandOrganisationRole |
Tree View
Table View
Extension | .. | |
Extension.extension | 2.. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | Coding | 1.. |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | Period | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-England-TypedPeriod" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" /> <version value="1.0.0" /> <name value="ExtensionEnglandTypedPeriod" /> <title value="Extension England Typed Period" /> <status value="draft" /> <date value="2023-10-13" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This supports the exchange of time periods. The extension time period is carried along with a code to identify whether the data is recorded for legal or operational periods." /> <purpose value="This extension has been created from an ORD use-case in which there is a requirement to hold data for Legal and Operational dates, although it is expected to be broader than ORD and can be used for other scenarios." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Organization" /> </context> <context> <type value="element" /> <expression value="OrganizationAffiliation" /> </context> <context> <type value="extension" /> <expression value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension"> <path value="Extension" /> <short value="This supports the recording of a period related to the specified date type." /> <definition value="This supports the recording of a period related to the specified date type. The date/time period is carried along with a code to identify the type of period." /> </element> <element id="Extension.extension"> <path value="Extension.extension" /> <min value="2" /> </element> <element id="Extension.extension:dateType"> <path value="Extension.extension" /> <sliceName value="dateType" /> <short value="Whether the Date Period is 'Legal' or 'Operational'." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:dateType.url"> <path value="Extension.extension.url" /> <fixedUri value="dateType" /> </element> <element id="Extension.extension:dateType.value[x]"> <path value="Extension.extension.value[x]" /> <short value="A ValueSet to identify the type of period." /> <min value="1" /> <type> <code value="Coding" /> </type> <binding> <strength value="extensible" /> <description value="The type of period data." /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-PeriodType" /> </binding> </element> <element id="Extension.extension:period"> <path value="Extension.extension" /> <sliceName value="period" /> <short value="The specific business related date or time period." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:period.url"> <path value="Extension.extension.url" /> <fixedUri value="period" /> </element> <element id="Extension.extension:period.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The date or time period." /> <min value="1" /> <type> <code value="Period" /> </type> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-England-TypedPeriod", "url": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod", "version": "1.0.0", "name": "ExtensionEnglandTypedPeriod", "title": "Extension England Typed Period", "status": "draft", "date": "2023-10-13", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "This supports the exchange of time periods. The extension time period is carried along with a code to identify whether the data is recorded for legal or operational periods.", "purpose": "This extension has been created from an ORD use-case in which there is a requirement to hold data for Legal and Operational dates, although it is expected to be broader than ORD and can be used for other scenarios.", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Organization" }, { "type": "element", "expression": "OrganizationAffiliation" }, { "type": "extension", "expression": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension", "path": "Extension", "short": "This supports the recording of a period related to the specified date type.", "definition": "This supports the recording of a period related to the specified date type. The date/time period is carried along with a code to identify the type of period." }, { "id": "Extension.extension", "path": "Extension.extension", "min": 2 }, { "id": "Extension.extension:dateType", "path": "Extension.extension", "sliceName": "dateType", "short": "Whether the Date Period is 'Legal' or 'Operational'.", "min": 1, "max": "1" }, { "id": "Extension.extension:dateType.url", "path": "Extension.extension.url", "fixedUri": "dateType" }, { "id": "Extension.extension:dateType.value[x]", "path": "Extension.extension.value[x]", "short": "A ValueSet to identify the type of period.", "min": 1, "type": [ { "code": "Coding" } ], "binding": { "strength": "extensible", "description": "The type of period data.", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-PeriodType" } }, { "id": "Extension.extension:period", "path": "Extension.extension", "sliceName": "period", "short": "The specific business related date or time period.", "min": 1, "max": "1" }, { "id": "Extension.extension:period.url", "path": "Extension.extension.url", "fixedUri": "period" }, { "id": "Extension.extension:period.value[x]", "path": "Extension.extension.value[x]", "short": "The date or time period.", "min": 1, "type": [ { "code": "Period" } ] }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-TypedPeriod" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Examples
None provided at this time.Extension Specific Guidance
There is a binding within this extension to ValueSet-England-PeriodTypeEngland Organisation Role
HTML View
ValueSet 'EnglandOrganisationRole'
Version | 1.0.0 |
Published by | NHS England |
Status | Draft (since 2023-11-16) |
This valueset defines the codes used to identify the role of an organisation.
Contact Information
NHS England
Email: interoperabilityteam@nhs.net
- Import all codes from CodeSystem EnglandORDOrganisationRole
Table View
ValueSet.id[0] | England-OrganisationRole |
ValueSet.url[0] | https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole |
ValueSet.version[0] | 1.0.0 |
ValueSet.name[0] | EnglandOrganisationRole |
ValueSet.title[0] | England Organisation Role |
ValueSet.status[0] | draft |
ValueSet.date[0] | 2023-11-16 |
ValueSet.publisher[0] | NHS England |
ValueSet.contact[0].name[0] | NHS England |
ValueSet.contact[0].telecom[0].system[0] | |
ValueSet.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
ValueSet.contact[0].telecom[0].use[0] | work |
ValueSet.contact[0].telecom[0].rank[0] | 1 |
ValueSet.description[0] | This valueset defines the codes used to identify the role of an organisation. |
ValueSet.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
ValueSet.compose[0].include[0].system[0] | https://ord.nhs.uk/CodeSystem/role |
XML View
<ValueSet xmlns="http://hl7.org/fhir"> <id value="England-OrganisationRole" /> <url value="https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole" /> <version value="1.0.0" /> <name value="EnglandOrganisationRole" /> <title value="England Organisation Role" /> <status value="draft" /> <date value="2023-11-16" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This valueset defines the codes used to identify the role of an organisation." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <compose> <include> <system value="https://ord.nhs.uk/CodeSystem/role" /> </include> </compose> </ValueSet>
JSON View
{ "resourceType": "ValueSet", "id": "England-OrganisationRole", "url": "https://fhir.nhs.uk/England/ValueSet/England-OrganisationRole", "version": "1.0.0", "name": "EnglandOrganisationRole", "title": "England Organisation Role", "status": "draft", "date": "2023-11-16", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "This valueset defines the codes used to identify the role of an organisation.", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "compose": { "include": [ { "system": "https://ord.nhs.uk/CodeSystem/role" } ] } }
England Period Type
HTML View
ValueSet 'EnglandPeriodType'
Version | 1.0.0 |
Published by | NHS England |
Status | Draft (since 2023-10-13) |
A ValueSet to identify the type of data for the date/time period described within the extension.
Contact Information
NHS England
Email: interoperabilityteam@nhs.net
- Import all codes from CodeSystem EnglandPeriodType
Expansion
This expansion was generated on 2023-10-13T13:34:44+00:00
This value set contains 2 concepts
Code | System | Display |
---|---|---|
legal | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType | Legal |
operational | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType | Operational |
Table View
ValueSet.id[0] | England-PeriodType |
ValueSet.url[0] | https://fhir.nhs.uk/England/ValueSet/England-PeriodType |
ValueSet.version[0] | 1.0.0 |
ValueSet.name[0] | EnglandPeriodType |
ValueSet.title[0] | England Period Type |
ValueSet.status[0] | draft |
ValueSet.date[0] | 2023-10-13 |
ValueSet.publisher[0] | NHS England |
ValueSet.contact[0].name[0] | NHS England |
ValueSet.contact[0].telecom[0].system[0] | |
ValueSet.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
ValueSet.contact[0].telecom[0].use[0] | work |
ValueSet.contact[0].telecom[0].rank[0] | 1 |
ValueSet.description[0] | A ValueSet to identify the type of data for the date/time period described within the extension. |
ValueSet.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
ValueSet.compose[0].include[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
ValueSet.expansion[0].timestamp[0] | 2023-10-13T13:34:44+00:00 |
ValueSet.expansion[0].total[0] | 2 |
ValueSet.expansion[0].offset[0] | 0 |
ValueSet.expansion[0].contains[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
ValueSet.expansion[0].contains[0].code[0] | legal |
ValueSet.expansion[0].contains[0].display[0] | Legal |
ValueSet.expansion[0].contains[1].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-PeriodType |
ValueSet.expansion[0].contains[1].code[0] | operational |
ValueSet.expansion[0].contains[1].display[0] | Operational |
XML View
<ValueSet xmlns="http://hl7.org/fhir"> <id value="England-PeriodType" /> <url value="https://fhir.nhs.uk/England/ValueSet/England-PeriodType" /> <version value="1.0.0" /> <name value="EnglandPeriodType" /> <title value="England Period Type" /> <status value="draft" /> <date value="2023-10-13" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="A ValueSet to identify the type of data for the date/time period described within the extension." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html." /> <compose> <include> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> </include> </compose> <expansion> <timestamp value="2023-10-13T13:34:44+00:00" /> <total value="2" /> <offset value="0" /> <contains> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <code value="legal" /> <display value="Legal" /> </contains> <contains> <system value="https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" /> <code value="operational" /> <display value="Operational" /> </contains> </expansion> </ValueSet>
JSON View
{ "resourceType": "ValueSet", "id": "England-PeriodType", "url": "https://fhir.nhs.uk/England/ValueSet/England-PeriodType", "version": "1.0.0", "name": "EnglandPeriodType", "title": "England Period Type", "status": "draft", "date": "2023-10-13", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "A ValueSet to identify the type of data for the date/time period described within the extension.", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "compose": { "include": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType" } ] }, "expansion": { "timestamp": "2023-10-13T13:34:44+00:00", "total": 2, "offset": 0, "contains": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "code": "legal", "display": "Legal" }, { "system": "https://fhir.nhs.uk/England/CodeSystem/England-PeriodType", "code": "operational", "display": "Operational" } ] } }
England Typed Date Time
HTML View
ValueSet 'EnglandTypedDateTime'
Version | 1.0.0 |
Published by | NHS England |
Status | Draft (since 2023-10-24) |
This ValueSet defines the set of codes that can be used to describe the type of business date and time being recorded.
Contact Information
NHS England
Email: interoperabilityteam@nhs.net
- Import all codes from CodeSystem EnglandORDDateTime
Expansion
This expansion was generated on 2023-10-24T17:45:44+00:00
This value set contains 1 concepts
Code | System | Display |
---|---|---|
last-change-date | https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime | Last Change Date |
Table View
ValueSet.id[0] | England-TypedDateTime |
ValueSet.url[0] | https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime |
ValueSet.version[0] | 1.0.0 |
ValueSet.name[0] | EnglandTypedDateTime |
ValueSet.title[0] | England Typed Date Time |
ValueSet.status[0] | draft |
ValueSet.date[0] | 2023-10-24 |
ValueSet.publisher[0] | NHS England |
ValueSet.contact[0].name[0] | NHS England |
ValueSet.contact[0].telecom[0].system[0] | |
ValueSet.contact[0].telecom[0].value[0] | interoperabilityteam@nhs.net |
ValueSet.contact[0].telecom[0].use[0] | work |
ValueSet.contact[0].telecom[0].rank[0] | 1 |
ValueSet.description[0] | This ValueSet defines the set of codes that can be used to describe the type of business date and time being recorded. |
ValueSet.copyright[0] | Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
ValueSet.compose[0].include[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime |
ValueSet.expansion[0].timestamp[0] | 2023-10-24T17:45:44+00:00 |
ValueSet.expansion[0].total[0] | 1 |
ValueSet.expansion[0].offset[0] | 0 |
ValueSet.expansion[0].contains[0].system[0] | https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime |
ValueSet.expansion[0].contains[0].code[0] | last-change-date |
ValueSet.expansion[0].contains[0].display[0] | Last Change Date |
XML View
<ValueSet xmlns="http://hl7.org/fhir"> <id value="England-TypedDateTime" /> <url value="https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime" /> <version value="1.0.0" /> <name value="EnglandTypedDateTime" /> <title value="England Typed Date Time" /> <status value="draft" /> <date value="2023-10-24" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This ValueSet defines the set of codes that can be used to describe the type of business date and time being recorded." /> <copyright value="Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <compose> <include> <system value="https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime" /> </include> </compose> <expansion> <timestamp value="2023-10-24T17:45:44+00:00" /> <total value="1" /> <offset value="0" /> <contains> <system value="https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime" /> <code value="last-change-date" /> <display value="Last Change Date" /> </contains> </expansion> </ValueSet>
JSON View
{ "resourceType": "ValueSet", "id": "England-TypedDateTime", "url": "https://fhir.nhs.uk/England/ValueSet/England-TypedDateTime", "version": "1.0.0", "name": "EnglandTypedDateTime", "title": "England Typed Date Time", "status": "draft", "date": "2023-10-24", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "This ValueSet defines the set of codes that can be used to describe the type of business date and time being recorded.", "copyright": "Copyright © 2023+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "compose": { "include": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime" } ] }, "expansion": { "timestamp": "2023-10-24T17:45:44+00:00", "total": 1, "offset": 0, "contains": [ { "system": "https://fhir.nhs.uk/England/CodeSystem/England-ORDDateTime", "code": "last-change-date", "display": "Last Change Date" } ] } }