CodeSystems

CodeSystem England-EndpointBusinessScenario

Description

A set of codes used to indicate the business scenario for which an endpoint is intended, particularly distinguishing between primary message recipients and copy recipients for NHS England messaging scenarios.

HTML View

Concepts

This code system https://fhir.nhs.uk/England/CodeSystem/England-EndpointBusinessScenario defines the following codes:

CodeDisplayDefinition
primary-recipientPrimary RecipientThe main recipient for the message. Used for most services and for GP direct patient dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information.
copy-recipientCopy RecipientA copy recipient for the message. Only used for Post Event Messaging (PEM) to GP services where GPs receive a copy of a call report when a patient has been treated by another service as a result of a call to 111.

Table View

CodeSystem.id[0]England-EndpointBusinessScenario
CodeSystem.url[0]https://fhir.nhs.uk/England/CodeSystem/England-EndpointBusinessScenario
CodeSystem.version[0]0.1.0
CodeSystem.name[0]EnglandEndpointBusinessScenario
CodeSystem.title[0]England Endpoint Business Scenario
CodeSystem.status[0]draft
CodeSystem.date[0]2025-07-21
CodeSystem.publisher[0]NHS England
CodeSystem.contact[0].name[0]NHS England
CodeSystem.contact[0].telecom[0].system[0]email
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 used to indicate the business scenario for which an endpoint is intended, particularly distinguishing between primary message recipients and copy recipients for NHS England messaging scenarios.
CodeSystem.copyright[0]Copyright © 2025+ 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]primary-recipient
CodeSystem.concept[0].display[0]Primary Recipient
CodeSystem.concept[0].definition[0]The main recipient for the message. Used for most services and for GP direct patient dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information.
CodeSystem.concept[1].code[0]copy-recipient
CodeSystem.concept[1].display[0]Copy Recipient
CodeSystem.concept[1].definition[0]A copy recipient for the message. Only used for Post Event Messaging (PEM) to GP services where GPs receive a copy of a call report when a patient has been treated by another service as a result of a call to 111.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
<id value="England-EndpointBusinessScenario" />
<url value="https://fhir.nhs.uk/England/CodeSystem/England-EndpointBusinessScenario" />
<version value="0.1.0" />
<name value="EnglandEndpointBusinessScenario" />
<title value="England Endpoint Business Scenario" />
<status value="draft" />
<date value="2025-07-21" />
<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 used to indicate the business scenario for which an endpoint is intended, particularly distinguishing between primary message recipients and copy recipients for NHS England messaging scenarios." />
<copyright value="Copyright © 2025+ 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="primary-recipient" />
<display value="Primary Recipient" />
<definition value="The main recipient for the message. Used for most services and for GP direct patient dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information." />
</concept>
<concept>
<code value="copy-recipient" />
<display value="Copy Recipient" />
<definition value="A copy recipient for the message. Only used for Post Event Messaging (PEM) to GP services where GPs receive a copy of a call report when a patient has been treated by another service as a result of a call to 111." />
</concept>
</CodeSystem>

JSON View

{
"resourceType": "CodeSystem",
"id": "England-EndpointBusinessScenario",
"url": "https://fhir.nhs.uk/England/CodeSystem/England-EndpointBusinessScenario",
"version": "0.1.0",
"name": "EnglandEndpointBusinessScenario",
"title": "England Endpoint Business Scenario",
"status": "draft",
"date": "2025-07-21",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "A set of codes used to indicate the business scenario for which an endpoint is intended, particularly distinguishing between primary message recipients and copy recipients for NHS England messaging scenarios.",
"copyright": "Copyright © 2025+ 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": "primary-recipient",
"display": "Primary Recipient",
"definition": "The main recipient for the message. Used for most services and for GP direct patient dispositions where the patient is being directed to their own GP and the GP needs to have direct access to the call information."
},
{
"code": "copy-recipient",
"display": "Copy Recipient",
"definition": "A copy recipient for the message. Only used for Post Event Messaging (PEM) to GP services where GPs receive a copy of a call report when a patient has been treated by another service as a result of a call to 111."
}
]
}

CodeSystem England-EndpointConnection

Description

A CodeSystem used to define the type of transport protocol to be used with a given endpoint connection.

HTML View

Concepts

This code system https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection defines the following codes:

CodeDisplayDefinition
itkInteroperability ToolkitNHS England Interoperability Toolkit (ITK) endpoint connection.
emailEmailEmail-based endpoint connection.
telnoTelephone NumberTelephone-based endpoint connection.
httpHTTPHypertext Transfer Protocol (HTTP) endpoint connection.

Table View

CodeSystem.id[0]England-EndpointConnection
CodeSystem.url[0]https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection
CodeSystem.version[0]0.1.0
CodeSystem.name[0]EnglandEndpointConnection
CodeSystem.title[0]England Endpoint Connection
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.date[0]2025-08-14
CodeSystem.publisher[0]NHS England
CodeSystem.contact[0].name[0]NHS England
CodeSystem.contact[0].telecom[0].system[0]email
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 CodeSystem used to define the type of transport protocol to be used with a given endpoint connection.
CodeSystem.copyright[0]Copyright © 2025+ 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.count[0]4
CodeSystem.concept[0].code[0]itk
CodeSystem.concept[0].display[0]Interoperability Toolkit
CodeSystem.concept[0].definition[0]NHS England Interoperability Toolkit (ITK) endpoint connection.
CodeSystem.concept[1].code[0]email
CodeSystem.concept[1].display[0]Email
CodeSystem.concept[1].definition[0]Email-based endpoint connection.
CodeSystem.concept[2].code[0]telno
CodeSystem.concept[2].display[0]Telephone Number
CodeSystem.concept[2].definition[0]Telephone-based endpoint connection.
CodeSystem.concept[3].code[0]http
CodeSystem.concept[3].display[0]HTTP
CodeSystem.concept[3].definition[0]Hypertext Transfer Protocol (HTTP) endpoint connection.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
<id value="England-EndpointConnection" />
<url value="https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection" />
<version value="0.1.0" />
<name value="EnglandEndpointConnection" />
<title value="England Endpoint Connection" />
<status value="draft" />
<experimental value="false" />
<date value="2025-08-14" />
<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 CodeSystem used to define the type of transport protocol to be used with a given endpoint connection." />
<copyright value="Copyright © 2025+ 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" />
<count value="4" />
<concept>
<code value="itk" />
<display value="Interoperability Toolkit" />
<definition value="NHS England Interoperability Toolkit (ITK) endpoint connection." />
</concept>
<concept>
<code value="email" />
<display value="Email" />
<definition value="Email-based endpoint connection." />
</concept>
<concept>
<code value="telno" />
<display value="Telephone Number" />
<definition value="Telephone-based endpoint connection." />
</concept>
<concept>
<code value="http" />
<display value="HTTP" />
<definition value="Hypertext Transfer Protocol (HTTP) endpoint connection." />
</concept>
</CodeSystem>

JSON View

{
"resourceType": "CodeSystem",
"id": "England-EndpointConnection",
"url": "https://fhir.nhs.uk/England/CodeSystem/England-EndpointConnection",
"version": "0.1.0",
"name": "EnglandEndpointConnection",
"title": "England Endpoint Connection",
"status": "draft",
"experimental": false,
"date": "2025-08-14",
"publisher": "NHS England",
"contact": [
{
"name": "NHS England",
"telecom": [
{
"system": "email",
"value": "interoperabilityteam@nhs.net",
"use": "work",
"rank": 1
}
]
}
],
"description": "A CodeSystem used to define the type of transport protocol to be used with a given endpoint connection.",
"copyright": "Copyright © 2025+ 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",
"count": 4,
"concept": [
{
"code": "itk",
"display": "Interoperability Toolkit",
"definition": "NHS England Interoperability Toolkit (ITK) endpoint connection."
},
{
"code": "email",
"display": "Email",
"definition": "Email-based endpoint connection."
},
{
"code": "telno",
"display": "Telephone Number",
"definition": "Telephone-based endpoint connection."
},
{
"code": "http",
"display": "HTTP",
"definition": "Hypertext Transfer Protocol (HTTP) endpoint connection."
}
]
}