StructureDefinition

Context of Use Patient

Canonical_URLStatusCurrent_VersionLast_UpdatedDescriptionProfile_Purpose
https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatusactive2.2.02023-12-07

The patient's death notification status.

This extension extends the Patient resource to support the exchange of the patient's death notification status.


Tree View

id0..1string
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueCodeableConceptCodeableConcept
id0..1string
extensionC0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
url1..1uriFixed Value

Detailed Descriptions

Extension
ShortThe patient's death notification status.
Definition

The patient's death notification status.

Cardinality0..1
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Extension.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension
ShortAdditional 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.

Cardinality1..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:deathNotificationStatus
ShortThe patient's death notification status.
Definition

The patient's death notification status.

Cardinality1..1
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:deathNotificationStatus.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:deathNotificationStatus.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:deathNotificationStatus.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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
deathNotificationStatus
Mappings
  • rim: N/A
Extension.extension:deathNotificationStatus.value[x]
ShortThe patient's death notification status.
Definition

The patient's death notification status.

Cardinality1..1
TypeCodeableConcept
Binding

UKCoreDeathNotificationStatus (extensible)

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.extension:systemEffectiveDate
ShortSystem effective date for patient's death notification status.
Definition

System effective date for patient's death notification status.

Cardinality0..1
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:systemEffectiveDate.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension:systemEffectiveDate.extension
ShortAdditional 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.

Cardinality0..*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
Extension.extension:systemEffectiveDate.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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
systemEffectiveDate
Mappings
  • rim: N/A
Extension.extension:systemEffectiveDate.value[x]
ShortSystem effective date for patient's death notification status.
Definition

System effective date for patient's death notification status.

Cardinality1..1
TypedateTime
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
Extension.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
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-DeathNotificationStatus
Mappings
  • rim: N/A
Extension.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
Typebase64Binary, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A

Table View

Extension..1
Extension.extension1..
Extension.extension:deathNotificationStatus1..1
Extension.extension:deathNotificationStatus.url..
Extension.extension:deathNotificationStatus.value[x]CodeableConcept1..
Extension.extension:systemEffectiveDate..1
Extension.extension:systemEffectiveDate.url..
Extension.extension:systemEffectiveDate.value[x]dateTime1..
Extension.url..
Extension.value[x]..0

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="Extension-UKCore-DeathNotificationStatus" />
<url value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" />
<version value="2.2.0" />
<name value="ExtensionUKCoreDeathNotificationStatus" />
<title value="Extension UK Core Death Notification Status" />
<status value="active" />
<date value="2023-12-07" />
<publisher value="HL7 UK" />
<name value="HL7 UK" />
<system value="email" />
<value value="ukcore@hl7.org.uk" />
<use value="work" />
<rank value="1" />
</telecom>
</contact>
<description value="The patient's death notification status." />
<purpose value="This extension extends the Patient resource to support the exchange of the patient's death notification status." />
<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" />
<identity value="rim" />
<uri value="http://hl7.org/v3" />
<name value="RIM Mapping" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="Patient" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension">
<path value="Extension" />
<short value="The patient's death notification status." />
<definition value="The patient's death notification status." />
<max value="1" />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<min value="1" />
</element>
<element id="Extension.extension:deathNotificationStatus">
<path value="Extension.extension" />
<sliceName value="deathNotificationStatus" />
<short value="The patient's death notification status." />
<definition value="The patient's death notification status." />
<min value="1" />
<max value="1" />
</element>
<element id="Extension.extension:deathNotificationStatus.url">
<path value="Extension.extension.url" />
<fixedUri value="deathNotificationStatus" />
</element>
<element id="Extension.extension:deathNotificationStatus.value[x]">
<path value="Extension.extension.value[x]" />
<short value="The patient's death notification status." />
<definition value="The patient's death notification status." />
<min value="1" />
<code value="CodeableConcept" />
</type>
<strength value="extensible" />
<valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DeathNotificationStatus" />
</binding>
</element>
<element id="Extension.extension:systemEffectiveDate">
<path value="Extension.extension" />
<sliceName value="systemEffectiveDate" />
<short value="System effective date for patient's death notification status." />
<definition value="System effective date for patient's death notification status." />
<max value="1" />
</element>
<element id="Extension.extension:systemEffectiveDate.url">
<path value="Extension.extension.url" />
<fixedUri value="systemEffectiveDate" />
</element>
<element id="Extension.extension:systemEffectiveDate.value[x]">
<path value="Extension.extension.value[x]" />
<short value="System effective date for patient's death notification status." />
<definition value="System effective date for patient's death notification status." />
<min value="1" />
<code value="dateTime" />
</type>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<max value="0" />
</element>
</differential>
</StructureDefinition>

JSON View

{
"resourceType": "StructureDefinition",
"id": "Extension-UKCore-DeathNotificationStatus",
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus",
"version": "2.2.0",
"name": "ExtensionUKCoreDeathNotificationStatus",
"title": "Extension UK Core Death Notification Status",
"status": "active",
"date": "2023-12-07",
"publisher": "HL7 UK",
"contact": [
{
"name": "HL7 UK",
"telecom": [
{
"system": "email",
"value": "ukcore@hl7.org.uk",
"use": "work",
"rank": 1
}
]
}
],
"description": "The patient's death notification status.",
"purpose": "This extension extends the Patient resource to support the exchange of the patient's death notification status.",
"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": "Patient"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "The patient's death notification status.",
"definition": "The patient's death notification status.",
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"min": 1
},
{
"id": "Extension.extension:deathNotificationStatus",
"path": "Extension.extension",
"sliceName": "deathNotificationStatus",
"short": "The patient's death notification status.",
"definition": "The patient's death notification status.",
"min": 1,
"max": "1"
},
{
"id": "Extension.extension:deathNotificationStatus.url",
"path": "Extension.extension.url",
"fixedUri": "deathNotificationStatus"
},
{
"id": "Extension.extension:deathNotificationStatus.value[x]",
"path": "Extension.extension.value[x]",
"short": "The patient's death notification status.",
"definition": "The patient's death notification status.",
"min": 1,
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DeathNotificationStatus"
}
},
{
"id": "Extension.extension:systemEffectiveDate",
"path": "Extension.extension",
"sliceName": "systemEffectiveDate",
"short": "System effective date for patient's death notification status.",
"definition": "System effective date for patient's death notification status.",
"max": "1"
},
{
"id": "Extension.extension:systemEffectiveDate.url",
"path": "Extension.extension.url",
"fixedUri": "systemEffectiveDate"
},
{
"id": "Extension.extension:systemEffectiveDate.value[x]",
"path": "Extension.extension.value[x]",
"short": "System effective date for patient's death notification status.",
"definition": "System effective date for patient's death notification status.",
"min": 1,
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"max": "0"
}
]
}
}

Examples

Feedback

Click here to:

Examples

Death notification Status- An example to illustrate the extension to indicate the death notification status of the patient.
Extension-UKCore-DeathNotificationStatus-Example

Extension Specific Guidance

There is a binding within this extension, deathNotificationStatus element to a ValueSet-UKCore-DeathNotificationStatus.