Package | uk-core-access |
Type | ImplementationGuide |
Id | uk-core-access |
FHIR Version | R4 |
Source | https://fhir.hl7.org.uk/uk-core-access/https://build.fhir.org/ig/HL7-UK/UK-Core-Access/index.html |
URL | https://fhir.hl7.org.uk/uk-core-access/ImplementationGuide/uk-core-access |
Version | 0.1.0 |
Status | draft |
Date | 2025-05-04T11:43:30+00:00 |
Name | UKCoreAccess |
Title | HL7 UK - UK Core Access |
Realm | uk |
Authority | hl7 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide uk-core-access
The official URL for this implementation guide is:
https://fhir.hl7.org.uk/uk-core-access/ImplementationGuide/uk-core-access
{ "resourceType": "ImplementationGuide", "id": "uk-core-access", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "url": "https://fhir.hl7.org.uk/uk-core-access/ImplementationGuide/uk-core-access", "version": "0.1.0", "name": "UKCoreAccess", "title": "HL7 UK - UK Core Access", "status": "draft", "date": "2025-05-04T11:43:30+00:00", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "url", "value": "https://www.hl7.org.uk/" } ] } ], "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "GB", "display": "United Kingdom of Great Britain and Northern Ireland" } ] } ], "packageId": "uk-core-access", "license": "Apache-2.0", "fhirVersion": [ "4.0.1" ], "dependsOn": [ { "id": "hl7tx", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment", "valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology" } ], "uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology", "packageId": "hl7.terminology.r4", "version": "6.3.0" }, { "id": "hl7ext", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment", "valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack" } ], "uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions", "packageId": "hl7.fhir.uv.extensions.r4", "version": "5.2.0" }, { "id": "fhir_r4_ukcore_stu1", "uri": "http://fhir.org/packages/fhir.r4.ukcore.stu1/ImplementationGuide/fhir.r4.ukcore.stu1", "packageId": "fhir.r4.ukcore.stu1", "version": "1.0.0" } ], "definition": { "extension": [ { "extension": [ { "url": "code", "valueString": "copyrightyear" }, { "url": "value", "valueString": "2023+" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "releaselabel" }, { "url": "value", "valueString": "ci-build" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "autoload-resources" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-liquid" }, { "url": "value", "valueString": "template/liquid" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-liquid" }, { "url": "value", "valueString": "input/liquid" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-qa" }, { "url": "value", "valueString": "temp/qa" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-temp" }, { "url": "value", "valueString": "temp/pages" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-output" }, { "url": "value", "valueString": "output" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-suppressed-warnings" }, { "url": "value", "valueString": "input/ignoreWarnings.txt" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "path-history" }, { "url": "value", "valueString": "https://fhir.hl7.org.uk/uk-core-access/history.html" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "template-html" }, { "url": "value", "valueString": "template-page.html" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "template-md" }, { "url": "value", "valueString": "template-page-md.html" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-contact" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-context" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-copyright" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-jurisdiction" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-license" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-publisher" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-version" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "apply-wg" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "active-tables" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "fmm-definition" }, { "url": "value", "valueString": "http://hl7.org/fhir/versions.html#maturity" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "propagate-status" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "excludelogbinaryformat" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueString": "tabbed-snapshots" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency", "valueCode": "hl7.fhir.uv.tools.r4#0.5.0" }, { "extension": [ { "url": "code", "valueCode": "copyrightyear" }, { "url": "value", "valueString": "2023+" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "releaselabel" }, { "url": "value", "valueString": "ci-build" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "autoload-resources" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-liquid" }, { "url": "value", "valueString": "template/liquid" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-liquid" }, { "url": "value", "valueString": "input/liquid" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-qa" }, { "url": "value", "valueString": "temp/qa" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-temp" }, { "url": "value", "valueString": "temp/pages" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-output" }, { "url": "value", "valueString": "output" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-suppressed-warnings" }, { "url": "value", "valueString": "input/ignoreWarnings.txt" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "path-history" }, { "url": "value", "valueString": "https://fhir.hl7.org.uk/uk-core-access/history.html" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "template-html" }, { "url": "value", "valueString": "template-page.html" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "template-md" }, { "url": "value", "valueString": "template-page-md.html" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-contact" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-context" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-copyright" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-jurisdiction" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-license" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-publisher" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-version" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "apply-wg" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "active-tables" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "fmm-definition" }, { "url": "value", "valueString": "http://hl7.org/fhir/versions.html#maturity" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "propagate-status" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "excludelogbinaryformat" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" }, { "extension": [ { "url": "code", "valueCode": "tabbed-snapshots" }, { "url": "value", "valueString": "true" } ], "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-parameter" } ], "resource": [ { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/b88f0099-5213-4502-a49d-cc3887027bdd" }, "name": "MaryMorris", "description": "Example patient MaryMorris", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/9708ceae-ddc8-49d2-97c1-f6f161e0104a" }, "name": "MichaelSmithies", "description": "Example patient Michael Smithies", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbybirthdate" }, "name": "Response-patientsearchbybirthdate", "description": "Result of searching for a patient by identifier value", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbyfamily" }, "name": "Response-patientsearchbyfamily", "description": "Result of searching for a patient by family name", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbygender" }, "name": "Response-patientsearchbygender", "description": "Result of searching for a patient by given name", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbygiven" }, "name": "Response-patientsearchbygiven", "description": "Result of searching for a patient by given name", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbyid" }, "name": "Response-patientsearchbyid", "description": "Result of searching for a patient by logical id", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbyidentifiervalue" }, "name": "Response-patientsearchbyidentifiervalue", "description": "Result of searching for a patient by identifier value", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbylocalsystem" }, "name": "Response-patientsearchbylocalsystem", "description": "Result of searching for a patient by local system", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbyname" }, "name": "Response-patientsearchbyname", "description": "Result of searching for a patient by part of name", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-patientsearchbynhsnumber" }, "name": "Response-patientsearchbynhsnumber", "description": "Result of searching for a patient by NHS Number", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/Response-searchreturnswarning" }, "name": "Response-searchreturnswarning", "description": "Search containing a warning message", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/57bae551-2c5d-4def-a541-4b156ec49497" }, "name": "RichardSmith", "description": "Example patient Richard Smith", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/UKCore-Patient" }, "name": "UK Core Patient", "description": "Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information.", "exampleBoolean": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/UKCoreAccessProvider-instance" }, "name": "UKCore Access", "description": "An example of a Provider supporting UKCore Access Patient Index Provider requirements.", "exampleBoolean": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/UKCoreAccessClinicalDataProvider" }, "name": "UKCore Access Clinical Data Provider", "description": "Provider supports read-only access to clinical data for the purposes of direct care and subject of care access.", "exampleBoolean": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/UKCoreAccessPatientIndexProvider" }, "name": "UKCore Access Patient Index Provider", "description": "Provider supports read-only access to a patient index for the purposes of direct care and subject of care access.", "exampleBoolean": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/UKCoreAccessPatientIndexPatient" }, "name": "UKCoreAccessPatientIndexPatient", "description": "UK Core Access Patient resource profile for patient index lookup, supporting basic data for identification", "exampleBoolean": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "OperationOutcome" } ], "reference": { "reference": "OperationOutcome/264a0630-af8f-4a78-9367-01d6871fec77" }, "name": "Warning", "description": "Example OperationOutcome containing warning", "exampleBoolean": true } ], "page": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "toc.html" } ], "nameUrl": "toc.html", "title": "Table of Contents", "generation": "html", "page": [ { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "index.html" } ], "nameUrl": "index.html", "title": "Home", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "clinical_data.html" } ], "nameUrl": "clinical_data.html", "title": "Clinical Data", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "consumer.html" } ], "nameUrl": "consumer.html", "title": "Consumer", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "exception_handling.html" } ], "nameUrl": "exception_handling.html", "title": "Exception Handling", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "history.html" } ], "nameUrl": "history.html", "title": "History", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "patient_index.html" } ], "nameUrl": "patient_index.html", "title": "Patient Index", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "related_specifications.html" } ], "nameUrl": "related_specifications.html", "title": "Related Specifications", "generation": "markdown" }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-page-name", "valueUrl": "safety_and_security.html" } ], "nameUrl": "safety_and_security.html", "title": "Safety and Security", "generation": "markdown" } ] }, "parameter": [ { "code": "path-resource", "value": "input/capabilities" }, { "code": "path-resource", "value": "input/examples" }, { "code": "path-resource", "value": "input/extensions" }, { "code": "path-resource", "value": "input/models" }, { "code": "path-resource", "value": "input/operations" }, { "code": "path-resource", "value": "input/profiles" }, { "code": "path-resource", "value": "input/resources" }, { "code": "path-resource", "value": "input/vocabulary" }, { "code": "path-resource", "value": "input/maps" }, { "code": "path-resource", "value": "input/testing" }, { "code": "path-resource", "value": "input/history" }, { "code": "path-resource", "value": "fsh-generated/resources" }, { "code": "path-pages", "value": "template/config" }, { "code": "path-pages", "value": "input/images" }, { "code": "path-tx-cache", "value": "input-cache/txcache" } ] } }