- This version of the UK Core is a development copy.
- This contains BREAKING CHANGES as a result of the C&TA Sprint 7 Review, and STU2 Sequence ballot reconciliation.
- This version is not yet reviewed for implementation. Other versions are available on the UK Core Version History Guide
- Please follow the guidance on the Contact Us page if you need any assistance.
- A summary of changes is available on the STU3 Sequence Change Log
StructureDefinition Extension-UKCore-LegalStatus
Context of Use | Encounter |
Canonical_URL | Status | Current_Version | Last_Updated | Description | Profile_Purpose |
---|---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus | active | 1.2.0 | 2023-12-12 | Information relating to a patient's legal status on admission or discharge. | This extension extends the Encounter Resource to support the exchange of information relating to a patient's legal status on admission or discharge. |
Tree View
ExtensionUKCoreLegalStatus (Extension) | I | Extension | |
id | 0..1 | string | |
extension | I | 2..* | Extension |
legalStatusContext | I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | Binding | |
valueCodeableConcept | CodeableConcept | ||
legalStatusClassification | I | 1..1 | Extension |
id | 0..1 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 1..1 | Binding | |
valueCodeableConcept | CodeableConcept | ||
url | 1..1 | uriFixed Value | |
value[x] | 0..0 |
Detailed Descriptions
Extension | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Extension.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 2...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:legalStatusContext | |
Definition | The context of the legal status in which a mental health legal status is being used. |
Cardinality | 1...1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Extension.extension:legalStatusContext.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.extension:legalStatusContext.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:legalStatusContext.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | legalStatusContext |
Mappings |
|
Extension.extension:legalStatusContext.value[x] | |
Definition | The context in which a mental health legal status is being used. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A set of codes that define the context in which a mental health legal status is being used. |
Invariants |
|
Mappings |
|
Extension.extension:legalStatusClassification | |
Definition | The classification of a patient's legal status, which is either informal or as designated in the Mental Health Act 1983 or other acts. |
Cardinality | 1...1 |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Extension.extension:legalStatusClassification.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Extension.extension:legalStatusClassification.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Extension.extension:legalStatusClassification.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | legalStatusClassification |
Mappings |
|
Extension.extension:legalStatusClassification.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A set of codes that define the classification of a patient's legal status which is either informal or as designated in the Mental Health Act 1983 or other acts. |
Invariants |
|
Mappings |
|
Extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus |
Mappings |
|
Extension.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Table View
Extension | .. | |
Extension.extension | 2.. | |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | CodeableConcept | 1.. |
Extension.extension | 1..1 | |
Extension.extension.url | .. | |
Extension.extension.value[x] | CodeableConcept | 1.. |
Extension.url | .. | |
Extension.value[x] | ..0 |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="Extension-UKCore-LegalStatus" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus" /> <version value="1.2.0" /> <name value="ExtensionUKCoreLegalStatus" /> <title value="Extension UK Core Legal Status" /> <status value="active" /> <date value="2023-12-12" /> <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="Information relating to a patient's legal status on admission or discharge." /> <purpose value="This extension extends the Encounter Resource to support the exchange of information relating to a patient's legal status on admission or discharge." /> <copyright value="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 value="4.0.1" /> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <kind value="complex-type" /> <abstract value="false" /> <context> <type value="element" /> <expression value="Encounter" /> </context> <type value="Extension" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" /> <derivation value="constraint" /> <differential> <element id="Extension.extension"> <path value="Extension.extension" /> <min value="2" /> </element> <element id="Extension.extension:legalStatusContext"> <path value="Extension.extension" /> <sliceName value="legalStatusContext" /> <short value="The context of the legal status." /> <definition value="The context of the legal status in which a mental health legal status is being used." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:legalStatusContext.url"> <path value="Extension.extension.url" /> <fixedUri value="legalStatusContext" /> </element> <element id="Extension.extension:legalStatusContext.value[x]"> <path value="Extension.extension.value[x]" /> <short value="The context in which a mental health legal status is being used." /> <definition value="The context in which a mental health legal status is being used." /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <description value="A set of codes that define the context in which a mental health legal status is being used." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusContext" /> </binding> </element> <element id="Extension.extension:legalStatusClassification"> <path value="Extension.extension" /> <sliceName value="legalStatusClassification" /> <short value="The classification of a patient's legal status." /> <definition value="The classification of a patient's legal status, which is either informal or as designated in the Mental Health Act 1983 or other acts." /> <min value="1" /> <max value="1" /> </element> <element id="Extension.extension:legalStatusClassification.url"> <path value="Extension.extension.url" /> <fixedUri value="legalStatusClassification" /> </element> <element id="Extension.extension:legalStatusClassification.value[x]"> <path value="Extension.extension.value[x]" /> <short value="Codes that define the classification of a patient's legal status" /> <min value="1" /> <type> <code value="CodeableConcept" /> </type> <binding> <strength value="extensible" /> <description value="A set of codes that define the classification of a patient's legal status which is either informal or as designated in the Mental Health Act 1983 or other acts." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusClassification" /> </binding> </element> <element id="Extension.url"> <path value="Extension.url" /> <fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus" /> </element> <element id="Extension.value[x]"> <path value="Extension.value[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "Extension-UKCore-LegalStatus", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus", "version": "1.2.0", "name": "ExtensionUKCoreLegalStatus", "title": "Extension UK Core Legal Status", "status": "active", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "Information relating to a patient's legal status on admission or discharge.", "purpose": "This extension extends the Encounter Resource to support the exchange of information relating to a patient's legal status on admission or discharge.", "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": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "context": [ { "type": "element", "expression": "Encounter" } ], "type": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "differential": { "element": [ { "id": "Extension.extension", "path": "Extension.extension", "min": 2 }, { "id": "Extension.extension:legalStatusContext", "path": "Extension.extension", "sliceName": "legalStatusContext", "short": "The context of the legal status.", "definition": "The context of the legal status in which a mental health legal status is being used.", "min": 1, "max": "1" }, { "id": "Extension.extension:legalStatusContext.url", "path": "Extension.extension.url", "fixedUri": "legalStatusContext" }, { "id": "Extension.extension:legalStatusContext.value[x]", "path": "Extension.extension.value[x]", "short": "The context in which a mental health legal status is being used.", "definition": "The context in which a mental health legal status is being used.", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "description": "A set of codes that define the context in which a mental health legal status is being used.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusContext" } }, { "id": "Extension.extension:legalStatusClassification", "path": "Extension.extension", "sliceName": "legalStatusClassification", "short": "The classification of a patient's legal status.", "definition": "The classification of a patient's legal status, which is either informal or as designated in the Mental Health Act 1983 or other acts.", "min": 1, "max": "1" }, { "id": "Extension.extension:legalStatusClassification.url", "path": "Extension.extension.url", "fixedUri": "legalStatusClassification" }, { "id": "Extension.extension:legalStatusClassification.value[x]", "path": "Extension.extension.value[x]", "short": "Codes that define the classification of a patient's legal status", "min": 1, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "description": "A set of codes that define the classification of a patient's legal status which is either informal or as designated in the Mental Health Act 1983 or other acts.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusClassification" } }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus" }, { "id": "Extension.value[x]", "path": "Extension.value[x]", "max": "0" } ] } }
Feedback
Click here to:Report issue for Extension-UKCore-LegalStatus, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
Examples
Legal Status- An example to illustrate the extension which is used to indicate a patient's legal status on admission or discharge.Example UKCore-Extension-LegalStatus
Extension Specific Guidance
There are two bindings within this extension. legalStatusContext
element to ValueSet UKCore-LegalStatusContext
, and legalStatusClassification
element to ValueSet UKCore-LegalStatusClassification.