StructureDefinition-UKCore-Organization

Table View

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.4.0" />
    <name value="UKCoreOrganization" />
    <title value="UK Core Organization" />
    <status value="active" />
    <date value="2023-04-28" />
    <publisher value="HL7 UK" />
    <contact>
        <name value="HL7 UK" />
        <telecom>
            <system value="email" />
            <value value="ukcore@hl7.org.uk" />
            <use value="work" />
            <rank value="1" />
        </telecom>
    </contact>
    <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Organization](https://hl7.org/fhir/R4/Organization.html)." />
    <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.type">
            <path value="Organization.type" />
            <binding>
                <strength value="extensible" />
                <description value="A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts" />
                <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType" />
            </binding>
        </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.4.0",
    "name": "UKCoreOrganization",
    "title": "UK Core Organization",
    "status": "active",
    "date": "2023-04-28",
    "publisher": "HL7 UK",
    "contact":  [
        {
            "name": "HL7 UK",
            "telecom":  [
                {
                    "system": "email",
                    "value": "ukcore@hl7.org.uk",
                    "use": "work",
                    "rank": 1
                }
            ]
        }
    ],
    "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Organization](https://hl7.org/fhir/R4/Organization.html).",
    "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.type",
                "path": "Organization.type",
                "binding": {
                    "strength": "extensible",
                    "description": "A set of concepts indicating the organisation type, derived from the base CodeSystem, and Genomics specific concepts",
                    "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-OrganizationType"
                }
            },
            {
                "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-LeedsTeachingHospital

Main Location - Example to illustrate the mainLocation extension.
Example UKCore-Extension-MainLocation

Organization Period - Example to illustrate the core-defined organization-period extension.
Example UKCore-Extension-OrganizationPeriod