{
"description": null,
"_filename": "NHSDigital-Organization.StructureDefinition.json",
"package_name": "uk.nhsdigital.r4.test",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"purpose": "NHS Digital generic definintion of the data requirements for Organization.",
"name": "NHSDigitalOrganization",
"abstract": false,
"type": "Organization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "2.8.7-prerelease",
"status": "draft",
"id": "3969b90a-49ff-4146-9fd6-56076ea4a573",
"kind": "resource",
"url": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-Organization",
"version": null,
"differential": {
"element": [ {
"id": "Organization.extension",
"min": 0,
"path": "Organization.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Organization.extension:relationships",
"max": "1",
"min": 0,
"path": "Organization.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-OrganisationRelationships" ]
} ],
"sliceName": "relationships"
}, {
"id": "Organization.identifier",
"min": 1,
"path": "Organization.identifier",
"comment": "MUST contain an ANANA/ODS code.",
"definition": "**MUST** contain an ANANA/ODS code. \r\n\r\n```json\r\n \"identifier\": [\r\n {\r\n \"use\": \"official\",\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"value\": \"RR805\"\r\n }\r\n ],\r\n```",
"mustSupport": true
}, {
"id": "Organization.identifier:odsSiteCode",
"max": "0",
"path": "Organization.identifier",
"sliceName": "odsSiteCode"
}, {
"id": "Organization.type",
"path": "Organization.type",
"binding": {
"strength": "required",
"valueSet": "https://fhir.nhs.uk/ValueSet/organisation-role"
},
"definition": "The Organisation types **MUST** be present and comes from the valueSet.\r\n`type` will also include details on when these roles applied, the current status and a boolean to indicate the Organisations primary role. These extensions are for API's produced by NHS Digital one, the are not expected to be present in resources created by NHS providers or suppliers.\r\n\r\n```json\r\n\r\n \"type\": [\r\n {\r\n \"extension\": [\r\n {\r\n \"url\": \"https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role\",\r\n \"extension\": [\r\n {\r\n \"url\": \"primaryRole\",\r\n \"valueBoolean\": true\r\n },\r\n {\r\n \"url\": \"status\",\r\n \"valueString\": \"Active\"\r\n }\r\n ]\r\n },\r\n {\r\n \"url\": \"https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod\",\r\n \"extension\": [\r\n {\r\n \"url\": \"activePeriod\",\r\n \"valuePeriod\": {\r\n \"start\": \"2020-04-01\"\r\n }\r\n },\r\n {\r\n \"url\": \"dateType\",\r\n \"valueString\": \"Operational\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"coding\": [\r\n {\r\n \"system\": \"https://fhir.nhs.uk/CodeSystem/organisation-role\",\r\n \"code\": \"198\",\r\n \"display\": \"NHS TRUST SITE\"\r\n }\r\n ]\r\n }\r\n ],\r\n```"
}, {
"id": "Organization.type.extension",
"min": 0,
"path": "Organization.type.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Organization.type.extension:activePeriod",
"min": 0,
"path": "Organization.type.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role-ActivePeriod" ]
} ],
"sliceName": "activePeriod"
}, {
"id": "Organization.type.extension:organisationRole",
"min": 0,
"path": "Organization.type.extension",
"type": [ {
"code": "Extension",
"profile": [ "https://fhir.nhs.uk/StructureDefinition/Extension-ODS-Organization-Role" ]
} ],
"sliceName": "organisationRole"
}, {
"id": "Organization.type.coding.system",
"min": 1,
"path": "Organization.type.coding.system",
"fixedUri": "https://fhir.nhs.uk/CodeSystem/organisation-role"
}, {
"id": "Organization.name",
"path": "Organization.name",
"definition": "The ODS/SDS name of the Organisation\r\n\r\n```json\r\n\r\n \"name\": \"NHS NIGHTINGALE HOSPITAL YORKSHIRE AND THE HUMBER\"\r\n```",
"mustSupport": true
}, {
"id": "Organization.telecom",
"path": "Organization.telecom",
"definition": "Contact phone numbers and address of the organisation.\r\n\r\n```json\r\n\r\n \"telecom\": [\r\n {\r\n \"system\": \"fax\",\r\n \"value\": \"0113 242 6496\",\r\n \"use\": \"work\"\r\n },\r\n {\r\n \"system\": \"phone\",\r\n \"value\": \"0113 243 3144\",\r\n \"use\": \"work\"\r\n }\r\n ],\r\n \"address\": [\r\n {\r\n \"line\": [\r\n \"KINGS ROAD\"\r\n ],\r\n \"city\": \"HARROGATE\",\r\n \"postalCode\": \"HG1 5LA\",\r\n \"country\": \"ENGLAND\"\r\n }\r\n ],\r\n \"partOf\": {\r\n \"reference\": \"https://directory.spineservices.nhs.uk/R4/Organization/RR805\",\r\n \"identifier\": {\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"value\": \"RR8\"\r\n }\r\n }\r\n```",
"mustSupport": true
}, {
"id": "Organization.telecom.value",
"min": 1,
"path": "Organization.telecom.value"
}, {
"id": "Organization.address",
"path": "Organization.address",
"definition": "Contact phone numbers and address of the organisation.\r\n\r\n```json\r\n\r\n \"telecom\": [\r\n {\r\n \"system\": \"fax\",\r\n \"value\": \"0113 242 6496\",\r\n \"use\": \"work\"\r\n },\r\n {\r\n \"system\": \"phone\",\r\n \"value\": \"0113 243 3144\",\r\n \"use\": \"work\"\r\n }\r\n ],\r\n \"address\": [\r\n {\r\n \"line\": [\r\n \"KINGS ROAD\"\r\n ],\r\n \"city\": \"HARROGATE\",\r\n \"postalCode\": \"HG1 5LA\",\r\n \"country\": \"ENGLAND\"\r\n }\r\n ],\r\n \"partOf\": {\r\n \"reference\": \"https://directory.spineservices.nhs.uk/R4/Organization/RR805\",\r\n \"identifier\": {\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"value\": \"RR8\"\r\n }\r\n }\r\n```",
"mustSupport": true
}, {
"id": "Organization.partOf",
"path": "Organization.partOf",
"constraint": [ {
"key": "nhsd-6",
"human": "partOf.display - a display name should be provided",
"severity": "warning",
"expression": "display.exists()"
} ],
"definition": "Recommended mandatory for primary care organisations.\r\n\r\n```json\r\n\r\n \"telecom\": [\r\n {\r\n \"system\": \"fax\",\r\n \"value\": \"0113 242 6496\",\r\n \"use\": \"work\"\r\n },\r\n {\r\n \"system\": \"phone\",\r\n \"value\": \"0113 243 3144\",\r\n \"use\": \"work\"\r\n }\r\n ],\r\n \"address\": [\r\n {\r\n \"line\": [\r\n \"KINGS ROAD\"\r\n ],\r\n \"city\": \"HARROGATE\",\r\n \"postalCode\": \"HG1 5LA\",\r\n \"country\": \"ENGLAND\"\r\n }\r\n ],\r\n \"partOf\": {\r\n \"reference\": \"https://directory.spineservices.nhs.uk/R4/Organization/RR805\",\r\n \"identifier\": {\r\n \"system\": \"https://fhir.nhs.uk/Id/ods-organization-code\",\r\n \"value\": \"RR8\"\r\n }\r\n }\r\n```",
"mustSupport": true
}, {
"id": "Organization.partOf.identifier",
"min": 1,
"path": "Organization.partOf.identifier"
}, {
"id": "Organization.partOf.identifier.system",
"min": 1,
"path": "Organization.partOf.identifier.system"
}, {
"id": "Organization.partOf.identifier.value",
"min": 1,
"path": "Organization.partOf.identifier.value"
} ]
},
"baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization"
}