StructureDefinition Extension-UKCore-AssociatedEncounter
Tree View
Table View
XML View
JSON View
Examples
Tree View
ExtensionUKCoreAssociatedEncounter ( Extension ) C Extension Element id Extension Short description An associated encounter reference.
Definition An associated encounter reference.
Data type Extension
Conditions The 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 childrenhasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not bothextension.exists() != value.exists()
Mappings id 0 .. 1 string There are no (further) constraints on this element
Element id Extension.id Short description 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.
Data type string
Mappings extension C 0 .. * Extension There are no (further) constraints on this element
Element id Extension.extension Short description Additional content defined by implementations
Alternate names extensions , user content
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.
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.
Data type Extension
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 childrenhasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not bothextension.exists() != value.exists()
Mappings url 1 .. 1 uri Auto Value Element id Extension.url Short description identifies the meaning of the extension
Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data type uri
Auto value https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter Mappings value[x] 1 .. 1 There are no (further) constraints on this element
Element id Extension.value[x] Short description Value of extension
Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints ele-1: All FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Mappings valueReference Reference ( Encounter ) Data type Reference ( Encounter )
XML View
< id value = " Extension-UKCore-AssociatedEncounter " />
< url value = " https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter " />
< name value = " ExtensionUKCoreAssociatedEncounter " />
< title value = " Extension UKCore AssociatedEncounter " />
< date value = " 2023-12-12 " />
< value value = " ukcore@hl7.org.uk " />
</ telecom >
</ contact >
< description value = " This extension is used to reference an associated encounter. " />
< purpose value = " This is a Genomics use case to record the the associated encounter for which Family Member History was recorded. " />
< 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. " />
< uri value = " http://hl7.org/v3 " />
< name value = " RIM Mapping " />
</ mapping >
< kind value = " complex-type " />
</ context >
< type value = " Extension " />
< baseDefinition value = " http://hl7.org/fhir/StructureDefinition/Extension " />
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status " >
</ extension >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version " >
</ extension >
< path value = " Extension " />
< short value = " An associated encounter reference. " />
< definition value = " An associated encounter reference. " />
< path value = " Extension " />
</ base >
< human value = " All FHIR elements must have a @value or children " />
< expression value = " hasValue() or (children().count() > id.count()) " />
< xpath value = " @value|f:*|h:div " />
< source value = " http://hl7.org/fhir/StructureDefinition/Element " />
</ constraint >
< human value = " Must have either extensions or value[x], not both " />
< expression value = " extension.exists() != value.exists() " />
< xpath value = " exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) " />
< source value = " http://hl7.org/fhir/StructureDefinition/Extension " />
</ constraint >
</ mapping >
</ mapping >
</ element >
< path value = " Extension.id " />
< short value = " Unique id for inter-element referencing " />
< definition value = " Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. " />
< path value = " Element.id " />
</ base >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type " >
</ extension >
< code value = " http://hl7.org/fhirpath/System.String " />
</ type >
</ mapping >
</ element >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status " >
</ extension >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version " >
</ extension >
< path value = " Extension.extension " />
</ discriminator >
< description value = " Extensions are always sliced by (at least) url " />
</ slicing >
< short value = " Additional content defined by implementations " />
< definition value = " 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. " />
< comment value = " 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. " />
< alias value = " extensions " />
< alias value = " user content " />
< path value = " Element.extension " />
</ base >
< code value = " Extension " />
</ type >
< human value = " All FHIR elements must have a @value or children " />
< expression value = " hasValue() or (children().count() > id.count()) " />
< xpath value = " @value|f:*|h:div " />
< source value = " http://hl7.org/fhir/StructureDefinition/Element " />
</ constraint >
< human value = " Must have either extensions or value[x], not both " />
< expression value = " extension.exists() != value.exists() " />
< xpath value = " exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) " />
< source value = " http://hl7.org/fhir/StructureDefinition/Extension " />
</ constraint >
</ mapping >
</ mapping >
</ element >
< path value = " Extension.url " />
< short value = " identifies the meaning of the extension " />
< definition value = " Source of the definition for the extension code - a logical name or a URL. " />
< comment value = " 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. " />
< path value = " Extension.url " />
</ base >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type " >
</ extension >
< code value = " http://hl7.org/fhirpath/System.String " />
</ type >
< fixedUri value = " https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter " />
</ mapping >
</ element >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status " >
</ extension >
< extension url = " http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version " >
</ extension >
< path value = " Extension.value[x] " />
< short value = " Value of extension " />
< definition value = " Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). " />
< path value = " Extension.value[x] " />
</ base >
< code value = " Reference " />
< targetProfile value = " http://hl7.org/fhir/StructureDefinition/Encounter " />
</ type >
< human value = " All FHIR elements must have a @value or children " />
< expression value = " hasValue() or (children().count() > id.count()) " />
< xpath value = " @value|f:*|h:div " />
< source value = " http://hl7.org/fhir/StructureDefinition/Element " />
</ constraint >
</ mapping >
</ mapping >
</ element >
</ snapshot >
< path value = " Extension " />
< short value = " An associated encounter reference. " />
< definition value = " An associated encounter reference. " />
</ element >
< path value = " Extension.url " />
< fixedUri value = " https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter " />
</ element >
< path value = " Extension.value[x] " />
< code value = " Reference " />
< targetProfile value = " http://hl7.org/fhir/StructureDefinition/Encounter " />
</ type >
</ element >
</ differential >
</ StructureDefinition >
JSON View
{
" id " : " Extension-UKCore-AssociatedEncounter " ,
" url " : " https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter " ,
" name " : " ExtensionUKCoreAssociatedEncounter " ,
" title " : " Extension UKCore AssociatedEncounter " ,
{
{
" value " : " ukcore@hl7.org.uk " ,
}
]
}
] ,
" description " : " This extension is used to reference an associated encounter. " ,
" purpose " : " This is a Genomics use case to record the the associated encounter for which Family Member History was recorded. " ,
" 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. " ,
{
" uri " : " http://hl7.org/v3 " ,
}
] ,
] ,
" baseDefinition " : " http://hl7.org/fhir/StructureDefinition/Extension " ,
{
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status " ,
} ,
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version " ,
}
] ,
" short " : " An associated encounter reference. " ,
" definition " : " An associated encounter reference. " ,
} ,
] ,
{
" human " : " All FHIR elements must have a @value or children " ,
" expression " : " hasValue() or (children().count() > id.count()) " ,
" xpath " : " @value|f:*|h:div " ,
" source " : " http://hl7.org/fhir/StructureDefinition/Element "
} ,
{
" human " : " Must have either extensions or value[x], not both " ,
" expression " : " extension.exists() != value.exists() " ,
" xpath " : " exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) " ,
" source " : " http://hl7.org/fhir/StructureDefinition/Extension "
}
] ,
]
} ,
{
] ,
" 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. " ,
} ,
{
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type " ,
}
] ,
" code " : " http://hl7.org/fhirpath/System.String "
}
] ,
]
} ,
{
" id " : " Extension.extension " ,
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status " ,
} ,
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version " ,
}
] ,
" path " : " Extension.extension " ,
] ,
" description " : " Extensions are always sliced by (at least) url " ,
} ,
" 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. " ,
" 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. " ,
" extensions " ,
" user content "
] ,
" path " : " Element.extension " ,
} ,
] ,
] ,
{
" human " : " All FHIR elements must have a @value or children " ,
" expression " : " hasValue() or (children().count() > id.count()) " ,
" xpath " : " @value|f:*|h:div " ,
" source " : " http://hl7.org/fhir/StructureDefinition/Element "
} ,
{
" human " : " Must have either extensions or value[x], not both " ,
" expression " : " extension.exists() != value.exists() " ,
" xpath " : " exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) " ,
" source " : " http://hl7.org/fhir/StructureDefinition/Extension "
}
] ,
]
} ,
{
] ,
" short " : " identifies the meaning of the extension " ,
" definition " : " Source of the definition for the extension code - a logical name or a 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. " ,
} ,
{
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type " ,
}
] ,
" code " : " http://hl7.org/fhirpath/System.String "
}
] ,
" fixedUri " : " https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter " ,
]
} ,
{
" id " : " Extension.value[x] " ,
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status " ,
} ,
{
" url " : " http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version " ,
}
] ,
" path " : " Extension.value[x] " ,
" short " : " Value of extension " ,
" definition " : " Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). " ,
" path " : " Extension.value[x] " ,
} ,
{
" http://hl7.org/fhir/StructureDefinition/Encounter "
]
}
] ,
] ,
{
" human " : " All FHIR elements must have a @value or children " ,
" expression " : " hasValue() or (children().count() > id.count()) " ,
" xpath " : " @value|f:*|h:div " ,
" source " : " http://hl7.org/fhir/StructureDefinition/Element "
}
] ,
]
}
]
} ,
{
" short " : " An associated encounter reference. " ,
" definition " : " An associated encounter reference. " ,
} ,
{
" fixedUri " : " https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AssociatedEncounter "
} ,
{
" id " : " Extension.value[x] " ,
" path " : " Extension.value[x] " ,
{
" http://hl7.org/fhir/StructureDefinition/Encounter "
]
}
]
}
]
}
}
Examples
Associated Encounter - An example to illustrate using the extension to indicate the encounter for which the family members condition was recorded.
Example UKCore-FamilyMemberHistory-Extension-AssociatedEncounter
Guidance
The resource being referenced SHOULD conform to the following Profile UKCore-Encounter .