{ "description": "Information relating to a patient's legal status on admission or discharge.", "_filename": "Extension-UKCore-LegalStatus.json", "package_name": "fhir.r4.ukcore.stu3.currentbuild", "date": "2023-12-12", "derivation": "constraint", "publisher": "HL7 UK", "fhirVersion": "4.0.1", "purpose": "This extension extends the Encounter Resource to support the exchange of information relating to a patient's legal status on admission or discharge.", "name": "ExtensionUKCoreLegalStatus", "mapping": [ { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" } ], "abstract": false, "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.", "type": "Extension", "experimental": null, "resourceType": "StructureDefinition", "title": "Extension UK Core Legal Status", "package_version": "0.0.15-pre-release", "snapshot": { "element": [ { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension", "min": 0, "definition": "Optional Extension Element - found in all resources.", "short": "Optional Extensions Element", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "max": "*", "id": "Extension", "condition": [ "ele-1" ], "base": { "max": "*", "min": 0, "path": "Extension" } }, { "path": "Extension.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension.extension", "min": 2, "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.", "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Extension.extension", "condition": [ "ele-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension.extension", "min": 1, "definition": "The context of the legal status in which a mental health legal status is being used.", "short": "The context of the legal status.", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "sliceName": "legalStatusContext", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "alias": [ "extensions", "user content" ], "max": "1", "id": "Extension.extension:legalStatusContext", "condition": [ "ele-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:legalStatusContext.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension.extension.extension", "min": 0, "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.", "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Extension.extension:legalStatusContext.extension", "condition": [ "ele-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "legalStatusContext", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:legalStatusContext.url", "comment": "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.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Extension.extension.value[x]", "min": 1, "definition": "The context in which a mental health legal status is being used.", "short": "The context in which a mental health legal status is being used.", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusContext", "description": "A set of codes that define the context in which a mental health legal status is being used." }, "max": "1", "id": "Extension.extension:legalStatusContext.value[x]", "condition": [ "ele-1" ], "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension.extension", "min": 1, "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.", "short": "The classification of a patient's legal status.", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "sliceName": "legalStatusClassification", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "alias": [ "extensions", "user content" ], "max": "1", "id": "Extension.extension:legalStatusClassification", "condition": [ "ele-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:legalStatusClassification.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Extension.extension.extension", "min": 0, "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.", "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Extension.extension:legalStatusClassification.extension", "condition": [ "ele-1" ], "comment": "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.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "Extension.extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "legalStatusClassification", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.extension:legalStatusClassification.url", "comment": "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.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Extension.extension.value[x]", "min": 1, "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "short": "Codes that define the classification of a patient's legal status", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusClassification", "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." }, "max": "1", "id": "Extension.extension:legalStatusClassification.value[x]", "condition": [ "ele-1" ], "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } }, { "path": "Extension.url", "min": 1, "definition": "Source of the definition for the extension code - a logical name or a URL.", "short": "identifies the meaning of the extension", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "uri" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Extension.url", "comment": "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.", "base": { "max": "1", "min": 1, "path": "Extension.url" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Extension.value[x]", "min": 0, "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).", "short": "Value of extension", "mapping": [ { "map": "n/a", "identity": "rim" }, { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "base64Binary" }, { "code": "boolean" }, { "code": "canonical" }, { "code": "code" }, { "code": "date" }, { "code": "dateTime" }, { "code": "decimal" }, { "code": "id" }, { "code": "instant" }, { "code": "integer" }, { "code": "markdown" }, { "code": "oid" }, { "code": "positiveInt" }, { "code": "string" }, { "code": "time" }, { "code": "unsignedInt" }, { "code": "uri" }, { "code": "url" }, { "code": "uuid" }, { "code": "Address" }, { "code": "Age" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "ContactPoint" }, { "code": "Count" }, { "code": "Distance" }, { "code": "Duration" }, { "code": "HumanName" }, { "code": "Identifier" }, { "code": "Money" }, { "code": "Period" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Ratio" }, { "code": "Reference" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "Timing" }, { "code": "ContactDetail" }, { "code": "Contributor" }, { "code": "DataRequirement" }, { "code": "Expression" }, { "code": "ParameterDefinition" }, { "code": "RelatedArtifact" }, { "code": "TriggerDefinition" }, { "code": "UsageContext" }, { "code": "Dosage" }, { "code": "Meta" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "max": "0", "id": "Extension.value[x]", "condition": [ "ele-1" ], "base": { "max": "1", "min": 0, "path": "Extension.value[x]" } } ] }, "status": "active", "id": "e01b75e1-e655-4c70-b236-3282174b0c71", "kind": "complex-type", "url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus", "context": [ { "type": "element", "expression": "Encounter" } ], "version": "1.2.0", "differential": { "element": [ { "id": "Extension.extension", "min": 2, "path": "Extension.extension" }, { "id": "Extension.extension:legalStatusContext", "max": "1", "min": 1, "path": "Extension.extension", "short": "The context of the legal status.", "sliceName": "legalStatusContext", "definition": "The context of the legal status in which a mental health legal status is being used." }, { "id": "Extension.extension:legalStatusContext.url", "path": "Extension.extension.url", "fixedUri": "legalStatusContext" }, { "id": "Extension.extension:legalStatusContext.value[x]", "min": 1, "path": "Extension.extension.value[x]", "type": [ { "code": "CodeableConcept" } ], "short": "The context in which a mental health legal status is being used.", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusContext", "description": "A set of codes that define 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." }, { "id": "Extension.extension:legalStatusClassification", "max": "1", "min": 1, "path": "Extension.extension", "short": "The classification of a patient's legal status.", "sliceName": "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." }, { "id": "Extension.extension:legalStatusClassification.url", "path": "Extension.extension.url", "fixedUri": "legalStatusClassification" }, { "id": "Extension.extension:legalStatusClassification.value[x]", "min": 1, "path": "Extension.extension.value[x]", "type": [ { "code": "CodeableConcept" } ], "short": "Codes that define the classification of a patient's legal status", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-LegalStatusClassification", "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." } }, { "id": "Extension.url", "path": "Extension.url", "fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-LegalStatus" }, { "id": "Extension.value[x]", "max": "0", "path": "Extension.value[x]" } ] }, "contact": [ { "name": "HL7 UK", "telecom": [ { "use": "work", "rank": 1, "value": "ukcore@hl7.org.uk", "system": "email" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension" }