UK Core Implementation Guide 0.4.0 - STU1

StructureDefinition-UKCore-Organization

Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information.

Profile Purpose

This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.

Snapshot View

mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
typeΣ0..*CodeableConcept
nameΣ I0..1string
alias0..*string
telecomI0..*ContactPoint
addressI0..*Address
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Differential View

mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
typeΣ0..*CodeableConcept
nameΣ I0..1string
alias0..*string
telecomI0..*ContactPoint
addressI0..*Address
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Hybrid View

mainLocationI0..*Extension(Reference(UK Core Location))
url1..1System.StringFixed Value
valuePeriodPeriod
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
activeΣ ?!0..1boolean
typeΣ0..*CodeableConcept
nameΣ I0..1string
alias0..*string
telecomI0..*ContactPoint
addressI0..*Address
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
referenceΣ I0..1string
typeΣ0..1uriBinding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ0..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(UK Core Organization)
displayΣ0..1string

Table View

Organization..
Organization.extension..
Organization.extensionExtension..
Organization.extensionExtension0..1
Organization.extension.value[x]..
Organization.identifier..
Organization.identifier..1
Organization.identifier.system1..
Organization.identifier.value1..
Organization.identifier.assignerReference(UK Core Organization)..
Organization.identifier..1
Organization.identifier.system1..
Organization.identifier.value1..
Organization.identifier.assignerReference(UK Core Organization)..
Organization.partOfReference(UK Core Organization)..
Organization.partOf.identifier..
Organization.partOf.identifier.assignerReference(UK Core Organization)..
Organization.endpoint..
Organization.endpoint.identifier..
Organization.endpoint.identifier.assignerReference(UK Core Organization)..


XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="UKCore-Organization" />
    <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
    <version value="2.1.0" />
    <name value="UKCoreOrganization" />
    <title value="UK Core Organization" />
    <status value="active" />
    <date value="2021-09-10" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="secretariat@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <contact>
        <name value="NHS Digital" />
        <telecom>
            <system value="email" />
            <value value="interoperabilityteam@nhs.net" />
            <use value="work" />
            <rank value="2" />
        </telecom>
    </contact>
    <description value="Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information." />
    <purpose value="This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc." />
    <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); 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 &quot;AS IS&quot; 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&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; 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="v2" />
        <uri value="http://hl7.org/v2" />
        <name value="HL7 v2 Mapping" />
    </mapping>
    <mapping>
        <identity value="rim" />
        <uri value="http://hl7.org/v3" />
        <name value="RIM Mapping" />
    </mapping>
    <mapping>
        <identity value="servd" />
        <uri value="http://www.omg.org/spec/ServD/1.0/" />
        <name value="ServD" />
    </mapping>
    <mapping>
        <identity value="w5" />
        <uri value="http://hl7.org/fhir/fivews" />
        <name value="FiveWs Pattern Mapping" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="Organization" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" />
    <derivation value="constraint" />
    <differential>
        <element id="Organization.extension">
            <path value="Organization.extension" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="url" />
                </discriminator>
                <rules value="open" />
            </slicing>
        </element>
        <element id="Organization.extension:mainLocation">
            <path value="Organization.extension" />
            <sliceName value="mainLocation" />
            <short value="Main location" />
            <definition value="The main location of the organisation." />
            <type>
                <code value="Extension" />
                <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation" />
            </type>
        </element>
        <element id="Organization.extension:organizationPeriod">
            <path value="Organization.extension" />
            <sliceName value="organizationPeriod" />
            <short value="The date range that this organization should be considered available." />
            <definition value="The date range that this organization should be considered available." />
            <min value="0" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://hl7.org/fhir/StructureDefinition/organization-period" />
            </type>
        </element>
        <element id="Organization.extension:organizationPeriod.value[x]">
            <path value="Organization.extension.value[x]" />
            <short value="The date range that this organization should be considered available." />
            <definition value="The date range that this organization should be considered available." />
        </element>
        <element id="Organization.identifier">
            <path value="Organization.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <ordered value="false" />
                <rules value="open" />
            </slicing>
        </element>
        <element id="Organization.identifier:odsOrganisationCode">
            <path value="Organization.identifier" />
            <sliceName value="odsOrganisationCode" />
            <short value="Organisation Data Service code" />
            <definition value="Identifier code supplier by the Organisation Data Service." />
            <max value="1" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-organization-code" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
        </element>
        <element id="Organization.identifier:odsOrganisationCode.assigner">
            <path value="Organization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Organization.identifier:odsSiteCode">
            <path value="Organization.identifier" />
            <sliceName value="odsSiteCode" />
            <short value="ODS Site code to identify the organisation at site level" />
            <definition value="ODS Site code to identify the organisation at site level." />
            <max value="1" />
        </element>
        <element id="Organization.identifier:odsSiteCode.system">
            <path value="Organization.identifier.system" />
            <min value="1" />
            <fixedUri value="https://fhir.nhs.uk/Id/ods-site-code" />
        </element>
        <element id="Organization.identifier:odsSiteCode.value">
            <path value="Organization.identifier.value" />
            <min value="1" />
        </element>
        <element id="Organization.identifier:odsSiteCode.assigner">
            <path value="Organization.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Organization.partOf">
            <path value="Organization.partOf" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Organization.partOf.identifier.assigner">
            <path value="Organization.partOf.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
        <element id="Organization.endpoint.identifier.assigner">
            <path value="Organization.endpoint.identifier.assigner" />
            <type>
                <code value="Reference" />
                <targetProfile value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "UKCore-Organization",
    "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
    "version": "2.1.0",
    "name": "UKCoreOrganization",
    "title": "UK Core Organization",
    "status": "active",
    "date": "2021-09-10",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "secretariat@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        },
        {
            "name": "NHS Digital",
            "telecom":  [
                {
                    "system": "email",
                    "value": "interoperabilityteam@nhs.net",
                    "use": "work",
                    "rank": 2
                }
            ]
        }
    ],
    "description": "Defines the UK Core constraints and extensions on the Organization resource for the minimal set of data to query and retrieve organisation information.",
    "purpose": "This profile allows exchange of a formally or informally recognised grouping of people or organisations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.",
    "copyright": "Copyright © 2021+ 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": "v2",
            "uri": "http://hl7.org/v2",
            "name": "HL7 v2 Mapping"
        },
        {
            "identity": "rim",
            "uri": "http://hl7.org/v3",
            "name": "RIM Mapping"
        },
        {
            "identity": "servd",
            "uri": "http://www.omg.org/spec/ServD/1.0/",
            "name": "ServD"
        },
        {
            "identity": "w5",
            "uri": "http://hl7.org/fhir/fivews",
            "name": "FiveWs Pattern Mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Organization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization.extension",
                "path": "Organization.extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "rules": "open"
                }
            },
            {
                "id": "Organization.extension:mainLocation",
                "path": "Organization.extension",
                "sliceName": "mainLocation",
                "short": "Main location",
                "definition": "The main location of the organisation.",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MainLocation"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.extension:organizationPeriod",
                "path": "Organization.extension",
                "sliceName": "organizationPeriod",
                "short": "The date range that this organization should be considered available.",
                "definition": "The date range that this organization should be considered available.",
                "min": 0,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/organization-period"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.extension:organizationPeriod.value[x]",
                "path": "Organization.extension.value[x]",
                "short": "The date range that this organization should be considered available.",
                "definition": "The date range that this organization should be considered available."
            },
            {
                "id": "Organization.identifier",
                "path": "Organization.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "Organization.identifier:odsOrganisationCode",
                "path": "Organization.identifier",
                "sliceName": "odsOrganisationCode",
                "short": "Organisation Data Service code",
                "definition": "Identifier code supplier by the Organisation Data Service.",
                "max": "1"
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-organization-code"
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.value",
                "path": "Organization.identifier.value",
                "min": 1
            },
            {
                "id": "Organization.identifier:odsOrganisationCode.assigner",
                "path": "Organization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.identifier:odsSiteCode",
                "path": "Organization.identifier",
                "sliceName": "odsSiteCode",
                "short": "ODS Site code to identify the organisation at site level",
                "definition": "ODS Site code to identify the organisation at site level.",
                "max": "1"
            },
            {
                "id": "Organization.identifier:odsSiteCode.system",
                "path": "Organization.identifier.system",
                "min": 1,
                "fixedUri": "https://fhir.nhs.uk/Id/ods-site-code"
            },
            {
                "id": "Organization.identifier:odsSiteCode.value",
                "path": "Organization.identifier.value",
                "min": 1
            },
            {
                "id": "Organization.identifier:odsSiteCode.assigner",
                "path": "Organization.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.partOf",
                "path": "Organization.partOf",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.partOf.identifier.assigner",
                "path": "Organization.partOf.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.endpoint.identifier.assigner",
                "path": "Organization.endpoint.identifier.assigner",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
                        ]
                    }
                ]
            }
        ]
    }
}

Examples

Hospital - Example to illustrate a Hospital organisation.
Example UKCore-Organization-Hospital

General Practice - Example to illustrate a General Practice organisation.
Example UKCore-Organization-GPPractice

Example Usage Scenarios

The following are example usage scenarios for the UK Core Organization profile:

  • Query for organisation information using the query parameter identifier `Organization.identifier) for a known ODS code.
  • Exchange organisation information within a FHIR document or message.

Profile specific implementation guidance:

Minimal Viable Content

As a minimum either a Organization.identifier or Organization.name should be provided.

All other elements are optional.


extension:mainLocation

More information about this extension can be found using the link below.

Extension UKCore-MainLocation.


extension:organizationPeriod

More information about this extension can be found using the link below.

Common Extension organization-period.


active

Whether the organization's record is still in active use.

identifier

The organisation ODS code and optionally the ODS site code for a specific site in the oranisation

Organisation

Organization.identifier:odsOrganisationCode.use

usual | official | temp | secondary | old (If known)

Organization.identifier:odsOrganisationCode.type

Not required for use with ODS

Organization.identifier:odsOrganisationCode.system

The url is https://fhir.nhs.uk/Id/ods-organization-code

Organization.identifier:odsOrganisationCode.value

The ODS code

Organization.identifier:odsOrganisationCode.period

The period for which the code is valid - May be ommitted

Organization.identifier:odsOrganisationCode.assigner

Implicit for ODS codes - Should be ommitted

Site

Organization.identifier:odsSiteCode.use

usual | official | temp | secondary | old (If known)

Organization.identifier:odsSiteCode.type

Not required for use with ODS

Organization.identifier:odsSiteCode.system

The url is https://fhir.nhs.uk/Id/ods-site-code

Organization.identifier:odsSiteCode.value

The ODS site code

Organization.identifier:odsSiteCode.period

The period for which the code is valid - May be omitted

Organization.identifier:odsSiteCode.assigner

Implicit for ODS site codes - Should be omitted

address

The address of the organization using the Address datatype.


contact

Contact for the organization for a certain purpose

HTML View

This code system http://terminology.hl7.org/CodeSystem/contactentity-type defines the following codes:

CodeDisplayDefinition
BILLBillingContact details for information regarding to billing/general finance enquiries.
ADMINAdministrativeContact details for administrative enquiries.
HRHuman ResourceContact details for issues related to Human Resources, such as staff matters, OH&S etc.
PAYORPayorContact details for dealing with issues related to insurance claims/adjudication/payment.
PATINFPatientGeneric information contact for patients.
PRESSPressDedicated contact point for matters relating to press enquiries.

Table View

CodeSystem.id[0]contactentity-type
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.meta[0].profile[0]http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]trial-use
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]3
CodeSystem.url[0]http://terminology.hl7.org/CodeSystem/contactentity-type
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.1129
CodeSystem.version[0]4.0.1
CodeSystem.name[0]ContactEntityType
CodeSystem.title[0]Contact entity type
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.publisher[0]FHIR Project team
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.description[0]This example value set defines a set of codes that can be used to indicate the purpose for which you would contact a contact party.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/contactentity-type
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]BILL
CodeSystem.concept[0].display[0]Billing
CodeSystem.concept[0].definition[0]Contact details for information regarding to billing/general finance enquiries.
CodeSystem.concept[1].code[0]ADMIN
CodeSystem.concept[1].display[0]Administrative
CodeSystem.concept[1].definition[0]Contact details for administrative enquiries.
CodeSystem.concept[2].code[0]HR
CodeSystem.concept[2].display[0]Human Resource
CodeSystem.concept[2].definition[0]Contact details for issues related to Human Resources, such as staff matters, OH&S etc.
CodeSystem.concept[3].code[0]PAYOR
CodeSystem.concept[3].display[0]Payor
CodeSystem.concept[3].definition[0]Contact details for dealing with issues related to insurance claims/adjudication/payment.
CodeSystem.concept[4].code[0]PATINF
CodeSystem.concept[4].display[0]Patient
CodeSystem.concept[4].definition[0]Generic information contact for patients.
CodeSystem.concept[5].code[0]PRESS
CodeSystem.concept[5].display[0]Press
CodeSystem.concept[5].definition[0]Dedicated contact point for matters relating to press enquiries.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="contactentity-type" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="3" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/contactentity-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1129" />
    </identifier>
    <version value="4.0.1" />
    <name value="ContactEntityType" />
    <title value="Contact entity type" />
    <status value="draft" />
    <experimental value="false" />
    <publisher value="FHIR Project team" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <description value="This example value set defines a set of codes that can be used to indicate the purpose for which you would contact a contact party." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/contactentity-type" />
    <content value="complete" />
    <concept>
        <code value="BILL" />
        <display value="Billing" />
        <definition value="Contact details for information regarding to billing/general finance enquiries." />
    </concept>
    <concept>
        <code value="ADMIN" />
        <display value="Administrative" />
        <definition value="Contact details for administrative enquiries." />
    </concept>
    <concept>
        <code value="HR" />
        <display value="Human Resource" />
        <definition value="Contact details for issues related to Human Resources, such as staff matters, OH&amp;S etc." />
    </concept>
    <concept>
        <code value="PAYOR" />
        <display value="Payor" />
        <definition value="Contact details for dealing with issues related to insurance claims/adjudication/payment." />
    </concept>
    <concept>
        <code value="PATINF" />
        <display value="Patient" />
        <definition value="Generic information contact for patients." />
    </concept>
    <concept>
        <code value="PRESS" />
        <display value="Press" />
        <definition value="Dedicated contact point for matters relating to press enquiries." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "contactentity-type",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00",
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 3
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/contactentity-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1129"
        }
    ],
    "version": "4.0.1",
    "name": "ContactEntityType",
    "title": "Contact entity type",
    "status": "draft",
    "experimental": false,
    "publisher": "FHIR Project team",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        }
    ],
    "description": "This example value set defines a set of codes that can be used to indicate the purpose for which you would contact a contact party.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/contactentity-type",
    "content": "complete",
    "concept":  [
        {
            "code": "BILL",
            "display": "Billing",
            "definition": "Contact details for information regarding to billing/general finance enquiries."
        },
        {
            "code": "ADMIN",
            "display": "Administrative",
            "definition": "Contact details for administrative enquiries."
        },
        {
            "code": "HR",
            "display": "Human Resource",
            "definition": "Contact details for issues related to Human Resources, such as staff matters, OH&S etc."
        },
        {
            "code": "PAYOR",
            "display": "Payor",
            "definition": "Contact details for dealing with issues related to insurance claims/adjudication/payment."
        },
        {
            "code": "PATINF",
            "display": "Patient",
            "definition": "Generic information contact for patients."
        },
        {
            "code": "PRESS",
            "display": "Press",
            "definition": "Dedicated contact point for matters relating to press enquiries."
        }
    ]
}

name

A string which is the name associated with the organisation.

type

The type of organisation.

The UK Core provides an example set of values, alternatives may be used.

HTML View

This code system http://terminology.hl7.org/CodeSystem/organization-type defines the following codes:

CodeDisplayDefinition
provHealthcare ProviderAn organization that provides healthcare services.
deptHospital DepartmentA department or ward within a hospital (Generally is not applicable to top level organizations)
teamOrganizational teamAn organizational team is usually a grouping of practitioners that perform a specific function within an organization (which could be a top level organization, or a department).
govtGovernmentA political body, often used when including organization records for government bodies such as a Federal Government, State or Local Government.
insInsurance CompanyA company that provides insurance to its subscribers that may include healthcare related policies.
payPayerA company, charity, or governmental organization, which processes claims and/or issues payments to providers on behalf of patients or groups of patients.
eduEducational InstituteAn educational institution that provides education or research facilities.
reliReligious InstitutionAn organization that is identified as a part of a religious institution.
crsClinical Research SponsorAn organization that is identified as a Pharmaceutical/Clinical Research Sponsor.
cgCommunity GroupAn un-incorporated community group.
busNon-Healthcare Business or CorporationAn organization that is a registered business or corporation but not identified by other types.
otherOtherOther type of organization not already specified.

Table View

CodeSystem.id[0]organization-type
CodeSystem.meta[0].lastUpdated[0]2019-11-01T09:29:23.356+11:00
CodeSystem.meta[0].profile[0]http://hl7.org/fhir/StructureDefinition/shareablecodesystem
CodeSystem.extension[0].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
CodeSystem.extension[0].valueCode[0]pa
CodeSystem.extension[1].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
CodeSystem.extension[1].valueCode[0]draft
CodeSystem.extension[2].url[0]http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
CodeSystem.extension[2].valueInteger[0]1
CodeSystem.url[0]http://terminology.hl7.org/CodeSystem/organization-type
CodeSystem.identifier[0].system[0]urn:ietf:rfc:3986
CodeSystem.identifier[0].value[0]urn:oid:2.16.840.1.113883.4.642.4.1128
CodeSystem.version[0]4.0.1
CodeSystem.name[0]OrganizationType
CodeSystem.title[0]Organization type
CodeSystem.status[0]draft
CodeSystem.experimental[0]False
CodeSystem.publisher[0]FHIR Project team
CodeSystem.contact[0].telecom[0].system[0]url
CodeSystem.contact[0].telecom[0].value[0]http://hl7.org/fhir
CodeSystem.description[0]This example value set defines a set of codes that can be used to indicate a type of organization.
CodeSystem.caseSensitive[0]True
CodeSystem.valueSet[0]http://hl7.org/fhir/ValueSet/organization-type
CodeSystem.content[0]complete
CodeSystem.concept[0].code[0]prov
CodeSystem.concept[0].display[0]Healthcare Provider
CodeSystem.concept[0].definition[0]An organization that provides healthcare services.
CodeSystem.concept[1].code[0]dept
CodeSystem.concept[1].display[0]Hospital Department
CodeSystem.concept[1].definition[0]A department or ward within a hospital (Generally is not applicable to top level organizations)
CodeSystem.concept[2].code[0]team
CodeSystem.concept[2].display[0]Organizational team
CodeSystem.concept[2].definition[0]An organizational team is usually a grouping of practitioners that perform a specific function within an organization (which could be a top level organization, or a department).
CodeSystem.concept[3].code[0]govt
CodeSystem.concept[3].display[0]Government
CodeSystem.concept[3].definition[0]A political body, often used when including organization records for government bodies such as a Federal Government, State or Local Government.
CodeSystem.concept[4].code[0]ins
CodeSystem.concept[4].display[0]Insurance Company
CodeSystem.concept[4].definition[0]A company that provides insurance to its subscribers that may include healthcare related policies.
CodeSystem.concept[5].code[0]pay
CodeSystem.concept[5].display[0]Payer
CodeSystem.concept[5].definition[0]A company, charity, or governmental organization, which processes claims and/or issues payments to providers on behalf of patients or groups of patients.
CodeSystem.concept[6].code[0]edu
CodeSystem.concept[6].display[0]Educational Institute
CodeSystem.concept[6].definition[0]An educational institution that provides education or research facilities.
CodeSystem.concept[7].code[0]reli
CodeSystem.concept[7].display[0]Religious Institution
CodeSystem.concept[7].definition[0]An organization that is identified as a part of a religious institution.
CodeSystem.concept[8].code[0]crs
CodeSystem.concept[8].display[0]Clinical Research Sponsor
CodeSystem.concept[8].definition[0]An organization that is identified as a Pharmaceutical/Clinical Research Sponsor.
CodeSystem.concept[9].code[0]cg
CodeSystem.concept[9].display[0]Community Group
CodeSystem.concept[9].definition[0]An un-incorporated community group.
CodeSystem.concept[10].code[0]bus
CodeSystem.concept[10].display[0]Non-Healthcare Business or Corporation
CodeSystem.concept[10].definition[0]An organization that is a registered business or corporation but not identified by other types.
CodeSystem.concept[11].code[0]other
CodeSystem.concept[11].display[0]Other
CodeSystem.concept[11].definition[0]Other type of organization not already specified.

XML View

<CodeSystem xmlns="http://hl7.org/fhir">
    <id value="organization-type" />
    <meta>
        <lastUpdated value="2019-11-01T09:29:23.356+11:00" />
        <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem" />
    </meta>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="draft" />
    </extension>
    <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="1" />
    </extension>
    <url value="http://terminology.hl7.org/CodeSystem/organization-type" />
    <identifier>
        <system value="urn:ietf:rfc:3986" />
        <value value="urn:oid:2.16.840.1.113883.4.642.4.1128" />
    </identifier>
    <version value="4.0.1" />
    <name value="OrganizationType" />
    <title value="Organization type" />
    <status value="draft" />
    <experimental value="false" />
    <publisher value="FHIR Project team" />
    <contact>
        <telecom>
            <system value="url" />
            <value value="http://hl7.org/fhir" />
        </telecom>
    </contact>
    <description value="This example value set defines a set of codes that can be used to indicate a type of organization." />
    <caseSensitive value="true" />
    <valueSet value="http://hl7.org/fhir/ValueSet/organization-type" />
    <content value="complete" />
    <concept>
        <code value="prov" />
        <display value="Healthcare Provider" />
        <definition value="An organization that provides healthcare services." />
    </concept>
    <concept>
        <code value="dept" />
        <display value="Hospital Department" />
        <definition value="A department or ward within a hospital (Generally is not applicable to top level organizations)" />
    </concept>
    <concept>
        <code value="team" />
        <display value="Organizational team" />
        <definition value="An organizational team is usually a grouping of practitioners that perform a specific function within an organization (which could be a top level organization, or a department)." />
    </concept>
    <concept>
        <code value="govt" />
        <display value="Government" />
        <definition value="A political body, often used when including organization records for government bodies such as a Federal Government, State or Local Government." />
    </concept>
    <concept>
        <code value="ins" />
        <display value="Insurance Company" />
        <definition value="A company that provides insurance to its subscribers that may include healthcare related policies." />
    </concept>
    <concept>
        <code value="pay" />
        <display value="Payer" />
        <definition value="A company, charity, or governmental organization, which processes claims and/or issues payments to providers on behalf of patients or groups of patients." />
    </concept>
    <concept>
        <code value="edu" />
        <display value="Educational Institute" />
        <definition value="An educational institution that provides education or research facilities." />
    </concept>
    <concept>
        <code value="reli" />
        <display value="Religious Institution" />
        <definition value="An organization that is identified as a part of a religious institution." />
    </concept>
    <concept>
        <code value="crs" />
        <display value="Clinical Research Sponsor" />
        <definition value="An organization that is identified as a Pharmaceutical/Clinical Research Sponsor." />
    </concept>
    <concept>
        <code value="cg" />
        <display value="Community Group" />
        <definition value="An un-incorporated community group." />
    </concept>
    <concept>
        <code value="bus" />
        <display value="Non-Healthcare Business or Corporation" />
        <definition value="An organization that is a registered business or corporation but not identified by other types." />
    </concept>
    <concept>
        <code value="other" />
        <display value="Other" />
        <definition value="Other type of organization not already specified." />
    </concept>
</CodeSystem>

JSON View

{
    "resourceType": "CodeSystem",
    "id": "organization-type",
    "meta": {
        "lastUpdated": "2019-11-01T09:29:23.356+11:00",
        "profile":  [
            "http://hl7.org/fhir/StructureDefinition/shareablecodesystem"
        ]
    },
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
            "valueCode": "pa"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "draft"
        },
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
            "valueInteger": 1
        }
    ],
    "url": "http://terminology.hl7.org/CodeSystem/organization-type",
    "identifier":  [
        {
            "system": "urn:ietf:rfc:3986",
            "value": "urn:oid:2.16.840.1.113883.4.642.4.1128"
        }
    ],
    "version": "4.0.1",
    "name": "OrganizationType",
    "title": "Organization type",
    "status": "draft",
    "experimental": false,
    "publisher": "FHIR Project team",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        }
    ],
    "description": "This example value set defines a set of codes that can be used to indicate a type of organization.",
    "caseSensitive": true,
    "valueSet": "http://hl7.org/fhir/ValueSet/organization-type",
    "content": "complete",
    "concept":  [
        {
            "code": "prov",
            "display": "Healthcare Provider",
            "definition": "An organization that provides healthcare services."
        },
        {
            "code": "dept",
            "display": "Hospital Department",
            "definition": "A department or ward within a hospital (Generally is not applicable to top level organizations)"
        },
        {
            "code": "team",
            "display": "Organizational team",
            "definition": "An organizational team is usually a grouping of practitioners that perform a specific function within an organization (which could be a top level organization, or a department)."
        },
        {
            "code": "govt",
            "display": "Government",
            "definition": "A political body, often used when including organization records for government bodies such as a Federal Government, State or Local Government."
        },
        {
            "code": "ins",
            "display": "Insurance Company",
            "definition": "A company that provides insurance to its subscribers that may include healthcare related policies."
        },
        {
            "code": "pay",
            "display": "Payer",
            "definition": "A company, charity, or governmental organization, which processes claims and/or issues payments to providers on behalf of patients or groups of patients."
        },
        {
            "code": "edu",
            "display": "Educational Institute",
            "definition": "An educational institution that provides education or research facilities."
        },
        {
            "code": "reli",
            "display": "Religious Institution",
            "definition": "An organization that is identified as a part of a religious institution."
        },
        {
            "code": "crs",
            "display": "Clinical Research Sponsor",
            "definition": "An organization that is identified as a Pharmaceutical/Clinical Research Sponsor."
        },
        {
            "code": "cg",
            "display": "Community Group",
            "definition": "An un-incorporated community group."
        },
        {
            "code": "bus",
            "display": "Non-Healthcare Business or Corporation",
            "definition": "An organization that is a registered business or corporation but not identified by other types."
        },
        {
            "code": "other",
            "display": "Other",
            "definition": "Other type of organization not already specified."
        }
    ]
}

alias

A list of alternate names that the organisation is known as, or was known as in the past.

telecom

A contact detail (e.g. a telephone number or an email address) by which the organisation may be contacted.

telecom uses the ContactPoint datatype.

partOf

A reference to an other organisation of which the organisation is a part by reference. The resource being referenced should conform to the following:

endpoint

Technical endpoints providing access to services operated for the organisation by reference. The resource being referenced must conform to

Can be used to define multiple technical endpoints.

back to top