- 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
| 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) | C | Extension | |
| id | 0..1 | string | |
| extension | C | 2..* | Extension |
| legalStatusContext | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| url | 1..1 | uriFixed Value | |
| value[x] | 1..1 | Binding | |
| valueCodeableConcept | CodeableConcept | ||
| legalStatusClassification | C | 1..1 | Extension |
| id | 0..1 | string | |
| extension | C | 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 | |
| Short | Optional Extensions Element |
| Definition | Optional Extension Element - found in all resources. |
| Cardinality | 0..* |
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 |
| Constraints |
|
| Mappings |
|
| Extension.id | |
| Short | Unique id for inter-element referencing |
| 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 | |
| Short | Additional content defined by implementations |
| 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Extension.extension: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. |
| 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. |
| Constraints |
|
| Mappings |
|
| Extension.extension:legalStatusContext.id | |
| Short | Unique id for inter-element referencing |
| 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 | |
| Short | Additional content defined by implementations |
| 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Extension.extension:legalStatusContext.url | |
| Short | identifies the meaning of the extension |
| 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] | |
| 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. |
| Cardinality | 1..1 |
| Type | CodeableConcept |
| Binding | A set of codes that define the context in which a mental health legal status is being used. |
| Constraints |
|
| Mappings |
|
| Extension.extension: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. |
| 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. |
| Constraints |
|
| Mappings |
|
| Extension.extension:legalStatusClassification.id | |
| Short | Unique id for inter-element referencing |
| 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 | |
| Short | Additional content defined by implementations |
| 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) Extensions are always sliced by (at least) url |
| Constraints |
|
| Mappings |
|
| Extension.extension:legalStatusClassification.url | |
| Short | identifies the meaning of the extension |
| 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] | |
| Short | Codes that define the classification of a patient's legal status |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility 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. |
| Constraints |
|
| Mappings |
|
| Extension.url | |
| Short | identifies the meaning of the extension |
| 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] | |
| Short | Value of extension |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..0 |
| Type | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Constraints |
|
| Mappings |
|
Table View
| Extension | .. | |
| Extension.extension | 2.. | |
| Extension.extension:legalStatusContext | 1..1 | |
| Extension.extension:legalStatusContext.url | .. | |
| Extension.extension:legalStatusContext.value[x] | CodeableConcept | 1.. |
| Extension.extension:legalStatusClassification | 1..1 | |
| Extension.extension:legalStatusClassification.url | .. | |
| Extension.extension:legalStatusClassification.value[x] | CodeableConcept | 1.. |
| Extension.url | .. | |
| Extension.value[x] | ..0 |
XML View
JSON View
Examples
Feedback
Click here to:Examples
Legal Status- An example to illustrate the extension which is used to indicate a patient's legal status on admission or discharge.Extension-UKCore-LegalStatus-Example
Extension Specific Guidance
There are two bindings within this extension. legalStatusContext element to ValueSet-UKCore-LegalStatusContext
, and legalStatusClassification element to ValueSet-UKCore-LegalStatusClassification.