Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition-Lab | draft | 2.4.0 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource Composition. |
Profile_Purpose |
---|
This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where |
Detailed Descriptions
Composition | |
Definition | A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition SHALL be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc. |
Cardinality | 0...* |
Comments | While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical. |
Invariants |
|
Mappings |
|
Composition.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Composition.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Composition.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Composition.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Composition.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Composition.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Composition.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Composition.extension:versionNumber | |
Definition | Version specific identifier for the composition, assigned when each version is created/updated. |
Cardinality | 0...* |
Type | Extension(string) |
Comments | While each resource, including the composition itself, has its own version identifier, this is a formal identifier for the logical version of the composition as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example. |
Invariants |
|
Composition.extension:basedOn-order-or-requisition | |
Definition | This extension provides a link to the order [(Reference(ServiceRequest)] or requisition [ServiceRequest.requisition (i.e., 'Request.groupIdentifier')] that this report document is based on and fulfills. |
Cardinality | 0...* |
Type | Extension(IdentifierReference(ServiceRequest)) |
Invariants |
|
Composition.extension:basedOn-order-or-requisition.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 |
|
Composition.extension:basedOn-order-or-requisition.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Composition.extension:basedOn-order-or-requisition.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 | http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition |
Mappings |
|
Composition.extension:basedOn-order-or-requisition.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 0...1 |
Type | Identifier |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Composition.extension:basedOn-order-or-requisition.value[x]:valueReference | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 0...1 |
Type | Reference(ServiceRequestLabEu) |
Invariants |
|
Mappings |
|
Composition.extension:information-recipient | |
Definition | This extension applies to the Composition resource and is used to represent an intended recipient of the composition. |
Cardinality | 0...* |
Type | Extension(Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization)) |
Invariants |
|
Composition.extension:information-recipient.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 |
|
Composition.extension:information-recipient.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Composition.extension:information-recipient.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 | http://hl7.eu/fhir/StructureDefinition/information-recipient |
Mappings |
|
Composition.extension:information-recipient.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 0...1 |
Type | Reference(PractitionerEu | Device | PatientEuLab | RelatedPerson | PractitionerRoleEu | Organization) |
Invariants |
|
Mappings |
|
Composition.extension:diagnosticReport-reference | |
Definition | This extension provides a reference to the DiagnosticReport instance that is associated with this Composition. |
Cardinality | 0...1 |
Type | Extension(Reference(DiagnosticReport)) |
Invariants |
|
Composition.extension:diagnosticReport-reference.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 |
|
Composition.extension:diagnosticReport-reference.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Composition.extension:diagnosticReport-reference.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 | http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference |
Mappings |
|
Composition.extension:diagnosticReport-reference.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(DiagnosticReportLabEu) |
Invariants |
|
Mappings |
|
Composition.extension:diagnosticReport-reference.value[x].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 |
|
Composition.extension:diagnosticReport-reference.value[x].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 |
|
Composition.extension:diagnosticReport-reference.value[x].reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | Added to the FHIR R4 guide to strictly conform with the R4 rules for document bundle resources inclusion. Using this extension implies to accept a circular reference Composition to/from DiagnosticReport |
Invariants |
|
Mappings |
|
Composition.extension:diagnosticReport-reference.value[x].type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Composition.extension:diagnosticReport-reference.value[x].identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Composition.extension:diagnosticReport-reference.value[x].display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Composition.extension:careSettingType | |
Definition | The type of care setting associated with a composition or a list. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Invariants |
|
Mappings |
|
Composition.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.identifier | |
Definition | Identifiers assigned to this Laboratory Report by the performer or other systems. It shall be common to several report versions |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | Composition.identifier SHALL be equal to one of the DiagnosticReport.identifier, if at least one exists |
Invariants |
|
Mappings |
|
Composition.status | |
Definition | The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document. |
Cardinality | 1...1 |
Type | code |
Binding | The workflow/clinical status of the composition. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark interim, amended, or withdrawn compositions or documents. |
Comments | DiagnosticReport.status and Composition.status shall be aligned, based on the http://hl7.eu/fhir/laboratory/ConceptMap/ConceptMap-eu-diagRptStatus2CompStatus mapping |
Invariants |
|
Mappings |
|
Composition.type | |
Definition | Specifies that it refers to a Laboratory Report |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | SNOMED CT Document Type |
Must Support | True |
Summary | True |
Requirements | Key metadata element describing the composition, used in searching/filtering. |
Comments | At least one DiagnosticReport.code.coding and Composition.type.coding SHALL be equal |
Invariants |
|
Mappings |
|
Composition.category | |
Definition | A code that classifies this laboratory report. Two basic categories has been selected in this guide: laboratory specialty and Study type. Laboratory specialty is characteristic of the laboratory that produced the test result while Study type is an arbitrary classificion of the test type. |
Cardinality | 0...* |
Type | CodeableConceptIPS |
Binding | A ValueSet to identify the category of a composition. |
Summary | True |
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. |
Comments | DiagnosticReport.category and Composition.category shall be aligned |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Composition.category:studyType | |
Definition | Laboratory services, i.e., results of tests performed, could be characterized using typology of services, commonly called study types. Study type could be seen as an attribute or grouping mechanism that assigns a common clinical sense to certain types of laboratory test results., e.g., Hemoglobin, Platelet count, etc. belongs to 'Hematology study'. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | LabStudyTypesEuVs (required) |
Summary | True |
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. |
Comments | In comparison to the laboratory specialty which is an attribute of laboratory, study type is a categorization of laboratory service. It needs to be mentioned that classification of test to study types in not standardized. |
Invariants |
|
Mappings |
|
Composition.category:specialty | |
Definition | Laboratory specialty is an attribute of any laboratory setting representing professional qualification of the laboratory to execute certain kind of laboratory tests. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | LabSpecialtyEuVs (required) |
Summary | True |
Requirements | Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents. |
Comments | Specialty could be used as parameter for searching/querying of laboratory test results. |
Invariants |
|
Mappings |
|
Composition.subject | |
Definition | Who or what this report is about. The report can be about a human patient, a living subject, a device (e.g. a machine), a location or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). |
Cardinality | 1...1 |
Type | Reference(PatientEuLab | PatientAnimalEu | Group | Location | Device) |
Must Support | True |
Summary | True |
Requirements | Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about. |
Comments | DiagnosticReport and Composition SHALL have the same subject |
Invariants |
|
Mappings |
|
Composition.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Requirements | Provides context for the composition and supports searching. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). DiagnosticReport and Composition SHALL have the same encounter. |
Invariants |
|
Mappings |
|
Composition.date | |
Definition | The composition editing time, when the composition was last logically changed by the author. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Requirements | dateTime is used for tracking, organizing versions and searching. Note that this is the time of authoring. When packaged in a document, Bundle.timestamp is the date of packaging. |
Comments | The Last Modified Date on the composition may be after the date of the document was attested without being changed. |
Invariants |
|
Mappings |
|
Composition.author | |
Definition | Identifies who is responsible for the information in the Laboratory Report, not necessarily who typed it in. |
Cardinality | 1...* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Must Support | True |
Summary | True |
Requirements | Identifies who is responsible for the content. |
Comments | If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author. |
Invariants |
|
Mappings |
|
Composition.title | |
Definition | Official human-readable label for the composition. For this document should be "Laboratory Report" or any equivalent translation |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period. |
Invariants |
|
Mappings |
|
Composition.confidentiality | |
Definition | The code specifying the level of confidentiality of the Composition. |
Cardinality | 0...1 |
Type | code |
Binding | Codes specifying the level of confidentiality of the composition. |
Must Support | True |
Summary | True |
Comments | The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section). This element is labeled as a modifier because highly confidential documents must not be treated as if they are not. |
Invariants |
|
Mappings |
|
Composition.attester | |
Definition | A participant who has attested to the accuracy of the composition/document. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Identifies responsibility for the accuracy of the composition content. |
Comments | Only list each attester once. |
Invariants |
|
Mappings |
|
Composition.attester.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 |
|
Composition.attester.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. |
Invariants |
|
Mappings |
|
Composition.attester.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.attester.mode | |
Definition | The type of attestation the authenticator offers. |
Cardinality | 1...1 |
Type | code |
Binding | The way in which a person authenticated a composition. |
Requirements | Indicates the level of authority of the attestation. |
Invariants |
|
Mappings |
|
Composition.attester.time | |
Definition | When the composition was attested by the party. |
Cardinality | 0...1 |
Type | dateTime |
Requirements | Identifies when the information in the composition was deemed accurate. (Things may have changed since then.). |
Invariants |
|
Mappings |
|
Composition.attester.party | |
Definition | Who attested the composition in the specified way. |
Cardinality | 0...1 |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) |
Requirements | Identifies who has taken on the responsibility for accuracy of the composition content. |
Comments | For a Laboratory Report it is usually non expected that the attester would be a Patient or a RealtedPerson |
Invariants |
|
Mappings |
|
Composition.custodian | |
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Requirements | Identifies where to go to find the current version, where to report issues, etc. |
Comments | This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged. |
Invariants |
|
Mappings |
|
Composition.relatesTo | |
Definition | Relationships that this composition has with other compositions or documents that already exist. |
Cardinality | 0...* |
Type | BackboneElement |
Comments | A document is a version specific composition. |
Invariants |
|
Mappings |
|
Composition.relatesTo.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 |
|
Composition.relatesTo.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. |
Invariants |
|
Mappings |
|
Composition.relatesTo.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.relatesTo.code | |
Definition | The type of relationship that this composition has with anther composition or document. |
Cardinality | 1...1 |
Type | code |
Binding | The type of relationship between documents. |
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
Invariants |
|
Mappings |
|
Composition.relatesTo.target[x] | |
Definition | The target composition/document of this relationship. |
Cardinality | 1...1 |
Type | Identifier |
Invariants |
|
Mappings |
|
Composition.event | |
Definition | The clinical service, such as a colonoscopy or an appendectomy, being documented. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Requirements | Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event. |
Comments | The event needs to be consistent with the type element, though can provide further information if desired. |
Invariants |
|
Mappings |
|
Composition.event.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 |
|
Composition.event.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. |
Invariants |
|
Mappings |
|
Composition.event.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.event.code | |
Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | This list of codes represents the main clinical acts being documented. |
Summary | True |
Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries. |
Invariants |
|
Mappings |
|
Composition.event.period | |
Definition | The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Composition.event.detail | |
Definition | The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy. |
Cardinality | 0...* |
Type | Reference(Resource) |
Summary | True |
Invariants |
|
Mappings |
|
Composition.section | |
Definition | The \"body\" of the report is organized as a tree of up to two levels of sections: top level sections represent laboratory specialties. A top level section SHALL contain either one text block carrying all the text results produced for this specialty along with Laboratory Data Entries or a set of Laboratory Report Item Sections. In the first case the specialty section happens to also be a leaf section. In the latter case, each (second level) leaf section contained in the (top level) specialty section represents a Report Item: i.e., a battery, a specimen study (especially in microbiology), or an individual test. In addition, any leaf section SHALL contain a Laboratory Data Entries containing the observations of that section in a machine-readable format. |
Cardinality | 1...* |
Type | BackboneElement |
Slicing | Unordered, Open, by $this.section(Exists), $this.entry(Exists) |
Invariants |
|
Mappings |
|
Composition.section.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 |
|
Composition.section.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. |
Invariants |
|
Mappings |
|
Composition.section.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.section.title | |
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. |
Cardinality | 1...1 |
Type | string |
Alias | header, label, caption |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. |
Invariants |
|
Mappings |
|
Composition.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | Classification of a section of a composition/document. |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. |
Invariants |
|
Mappings |
|
Composition.section.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants |
|
Mappings |
|
Composition.section.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants |
|
Mappings |
|
Composition.section.text | |
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. |
Cardinality | 0...1 |
Type | Narrative |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants |
|
Mappings |
|
Composition.section.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Cardinality | 0...1 |
Type | code |
Binding | The processing mode that applies to this section. |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
Invariants |
|
Mappings |
|
Composition.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | What order applies to the items in the entry. |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
Invariants |
|
Mappings |
|
Composition.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Cardinality | 0...* |
Type | Reference(Resource) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants |
|
Mappings |
|
Composition.section.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | If a section is empty, why it is empty. |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
Invariants |
|
Mappings |
|
Composition.section.section | |
Definition | A nested sub-section within this section. |
Cardinality | 0...* |
Type | see (section) |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections | |
Definition | Variant 1: With this option, all laboratory report data entries are provided in the top level sections and no sub-sections are allowed. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.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 |
|
Composition.section:lab-no-subsections.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. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.section:lab-no-subsections.title | |
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. |
Cardinality | 1...1 |
Type | string |
Alias | header, label, caption |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | LabStudyTypesEuVs (preferred) |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.text | |
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. |
Cardinality | 0...1 |
Type | Narrative |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Cardinality | 0...1 |
Type | code |
Binding | The processing mode that applies to this section. |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | What order applies to the items in the entry. |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Cardinality | 1...* |
Type | Reference(ObservationResultsLaboratoryEu) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | If a section is empty, why it is empty. |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
Invariants |
|
Mappings |
|
Composition.section:lab-no-subsections.section | |
Definition | A nested sub-section within this section. |
Cardinality | 0...0 |
Type | see (section) |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections | |
Definition | Variant 2: With this option, this top level section doesn't include NEITHER a top level text NOR entry elements. Each Report Item is contained in a corresponding sub-sections which contains the Lab Report Data Entry. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.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 |
|
Composition.section:lab-subsections.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. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.section:lab-subsections.title | |
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. |
Cardinality | 1...1 |
Type | string |
Alias | header, label, caption |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | LabStudyTypesEuVs (preferred) |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.text | |
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. |
Cardinality | 0...0 |
Type | Narrative |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Cardinality | 0...1 |
Type | code |
Binding | The processing mode that applies to this section. |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | What order applies to the items in the entry. |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Cardinality | 0...0 |
Type | Reference(Resource) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | If a section is empty, why it is empty. |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section | |
Definition | A nested sub-section within this section. |
Cardinality | 1...* |
Type | BackboneElement |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.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 |
|
Composition.section:lab-subsections.section.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. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.section:lab-subsections.section.title | |
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. |
Cardinality | 1...1 |
Type | string |
Alias | header, label, caption |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | LabStudyTypesEuVs (preferred) |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.text | |
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. |
Cardinality | 0...1 |
Type | Narrative |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Cardinality | 0...1 |
Type | code |
Binding | The processing mode that applies to this section. |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | What order applies to the items in the entry. |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Cardinality | 1...* |
Type | Reference(ObservationResultsLaboratoryEu) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | If a section is empty, why it is empty. |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
Invariants |
|
Mappings |
|
Composition.section:lab-subsections.section.section | |
Definition | A nested sub-section within this section. |
Cardinality | 0...0 |
Type | see (section) |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants |
|
Mappings |
|
Composition.section:annotations | |
Definition | Narrative expression of comments accompanying the report, such as suggestions for evaluation, technical notes from the laboratory, etc. Examples: Suggestion: This result should be evaluated in relation to the patient's medical history and clinical condition. Technical note: A list of accredited examination(s) is available at www.laboratory.com. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Composition.section:annotations.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 |
|
Composition.section:annotations.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. |
Invariants |
|
Mappings |
|
Composition.section:annotations.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Composition.section:annotations.title | |
Definition | The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents. |
Cardinality | 1...1 |
Type | string |
Alias | header, label, caption |
Requirements | Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized. |
Comments | The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element. |
Invariants |
|
Mappings |
|
Composition.section:annotations.code | |
Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | Classification of a section of a composition/document. |
Requirements | Provides computable standardized labels to topics within the document. |
Comments | The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code. |
Invariants |
|
Pattern | { "coding": [ { "system": "http://loinc.org", "code": "48767-8" } ] } |
Mappings |
|
Composition.section:annotations.author | |
Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) |
Requirements | Identifies who is responsible for the content. |
Invariants |
|
Mappings |
|
Composition.section:annotations.focus | |
Definition | The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Comments | Typically, sections in a doument are about the subject of the document, whether that is a patient, or group of patients, location, or device, or whatever. For some kind of documents, some sections actually contain data about related entities. Typical examples are a section in a newborn discharge summary concerning the mother, or family history documents, with a section about each family member, though there are many other examples. |
Invariants |
|
Mappings |
|
Composition.section:annotations.text | |
Definition | A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. |
Cardinality | 1...1 |
Type | Narrative |
Comments | Document profiles may define what content should be represented in the narrative to ensure clinical safety. |
Invariants |
|
Mappings |
|
Composition.section:annotations.mode | |
Definition | How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
Cardinality | 0...1 |
Type | code |
Binding | The processing mode that applies to this section. |
Requirements | Sections are used in various ways, and it must be known in what way it is safe to use the entries in them. |
Comments | This element is labeled as a modifier because a change list must not be misunderstood as a complete list. |
Invariants |
|
Mappings |
|
Composition.section:annotations.orderedBy | |
Definition | Specifies the order applied to the items in the section entries. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | What order applies to the items in the entry. |
Requirements | Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries. |
Comments | Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order. |
Invariants |
|
Mappings |
|
Composition.section:annotations.entry | |
Definition | A reference to the actual resource from which the narrative in the section is derived. |
Cardinality | 0...0 |
Type | Reference(Resource) |
Comments | If there are no entries in the list, an emptyReason SHOULD be provided. |
Invariants |
|
Mappings |
|
Composition.section:annotations.emptyReason | |
Definition | If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | If a section is empty, why it is empty. |
Requirements | Allows capturing things like "none exist" or "not asked" which can be important for most lists. |
Comments | The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases. |
Invariants |
|
Mappings |
|
Composition.section:annotations.section | |
Definition | A nested sub-section within this section. |
Cardinality | 0...0 |
Type | see (section) |
Comments | Nested sections are primarily used to help human readers navigate to particular portions of the document. |
Invariants |
|
Mappings |
|
Table View
Composition | .. | |
Composition.extension | Extension | ..1 |
Composition.status | .. | |
Composition.type | .. | |
Composition.category | .. | |
Composition.subject | .. | |
Composition.author | .. | |
Composition.confidentiality | .. | |
Composition.custodian | .. | |
Composition.section | .. | |
Composition.section.code | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Composition-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition-Lab" /> <version value="2.4.0" /> <name value="UKCoreCompositionLab" /> <title value="UK Core Composition Lab" /> <status value="draft" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [Composition](https://hl7.org/fhir/R4/Composition.html)." /> <purpose value="This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. \n\nA Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where `Bundle.type=document`, and any other resources referenced from Composition SHALL be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="Composition" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab" /> <derivation value="constraint" /> <differential> <element id="Composition"> <path value="Composition" /> <definition value="A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition SHALL be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc." /> </element> <element id="Composition.extension:careSettingType"> <path value="Composition.extension" /> <sliceName value="careSettingType" /> <short value="Used to support the type of care setting associated with a composition or a list." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" /> </type> </element> <element id="Composition.status"> <path value="Composition.status" /> <short value="The workflow / clinical status of this composition." /> <mustSupport value="true" /> </element> <element id="Composition.type"> <path value="Composition.type" /> <short value="Specifies the particular kind of composition." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <description value="SNOMED CT Document Type" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType" /> </binding> </element> <element id="Composition.category"> <path value="Composition.category" /> <binding> <strength value="preferred" /> <description value="A ValueSet to identify the category of a composition." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionCategory" /> </binding> </element> <element id="Composition.subject"> <path value="Composition.subject" /> <short value="Who and / or what the composition is about." /> <mustSupport value="true" /> </element> <element id="Composition.author"> <path value="Composition.author" /> <short value="Identifies who is responsible for the information in the composition." /> <mustSupport value="true" /> </element> <element id="Composition.confidentiality"> <path value="Composition.confidentiality" /> <short value="The code specifying the level of confidentiality of the Composition." /> <mustSupport value="true" /> </element> <element id="Composition.custodian"> <path value="Composition.custodian" /> <short value="Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information." /> <mustSupport value="true" /> </element> <element id="Composition.section.code"> <path value="Composition.section.code" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionSectionCode" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Composition-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Composition-Lab", "version": "2.4.0", "name": "UKCoreCompositionLab", "title": "UK Core Composition Lab", "status": "draft", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Composition](https://hl7.org/fhir/R4/Composition.html).", "purpose": "This profile allows a record of a set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. \n\nA Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where `Bundle.type=document`, and any other resources referenced from Composition SHALL be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc.", "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", "kind": "resource", "abstract": false, "type": "Composition", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/Composition-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "Composition", "path": "Composition", "definition": "A set of healthcare-related information that is assembled together into a single logical package that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition SHALL be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition SHALL be included as subsequent entries in the Bundle, for example Patient, Practitioner, Encounter, etc." }, { "id": "Composition.extension:careSettingType", "path": "Composition.extension", "sliceName": "careSettingType", "short": "Used to support the type of care setting associated with a composition or a list.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CareSettingType" ] } ] }, { "id": "Composition.status", "path": "Composition.status", "short": "The workflow / clinical status of this composition.", "mustSupport": true }, { "id": "Composition.type", "path": "Composition.type", "short": "Specifies the particular kind of composition.", "mustSupport": true, "binding": { "strength": "preferred", "description": "SNOMED CT Document Type", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-DocumentType" } }, { "id": "Composition.category", "path": "Composition.category", "binding": { "strength": "preferred", "description": "A ValueSet to identify the category of a composition.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionCategory" } }, { "id": "Composition.subject", "path": "Composition.subject", "short": "Who and / or what the composition is about.", "mustSupport": true }, { "id": "Composition.author", "path": "Composition.author", "short": "Identifies who is responsible for the information in the composition.", "mustSupport": true }, { "id": "Composition.confidentiality", "path": "Composition.confidentiality", "short": "The code specifying the level of confidentiality of the Composition.", "mustSupport": true }, { "id": "Composition.custodian", "path": "Composition.custodian", "short": "Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.", "mustSupport": true }, { "id": "Composition.section.code", "path": "Composition.section.code", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-CompositionSectionCode" } } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport-Lab | active | 2.0.1 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource DiagnosticReport, to provide laboratory specific support for test results. |
Profile_Purpose |
---|
To provide implementers with additional support when implementing test result data and to provide a consistent structure to how the data is presented. |
Detailed Descriptions
DiagnosticReport | |
Definition | Laboratory Report DiagnosticReport |
Cardinality | 0...* |
Alias | Report, Test, Result, Results, Labs, Laboratory |
Comments | This is intended to capture a single report and is not suitable for use in displaying summary information that covers multiple reports. For example, this resource has not been designed for laboratory cumulative reporting formats nor detailed structured reports for sequencing. |
Invariants |
|
Mappings |
|
DiagnosticReport.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
DiagnosticReport.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
DiagnosticReport.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
DiagnosticReport.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
DiagnosticReport.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
DiagnosticReport.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
DiagnosticReport.extension | |
Definition | An Extension |
Cardinality | 1...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
DiagnosticReport.extension:DiagnosticReportCompositionR5 | |
Definition | This extension implements the R5 composition element. It allow to link this DiagnosticReport with the Composition documenting this Laboratory Report. |
Cardinality | 1...1 |
Type | Extension(Reference(UKCoreComposition)) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:DiagnosticReportCompositionR5.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 |
|
DiagnosticReport.extension:DiagnosticReportCompositionR5.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
DiagnosticReport.extension:DiagnosticReportCompositionR5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition |
Mappings |
|
DiagnosticReport.extension:DiagnosticReportCompositionR5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(CompositionLabReportEu) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5 | |
Definition | A Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
Cardinality | 0...1 |
Type | Extension(Reference(UKCoreComposition)) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5.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 |
|
DiagnosticReport.extension:compositionReferenceR5.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 |
|
DiagnosticReport.extension:compositionReferenceR5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition |
Mappings |
|
DiagnosticReport.extension:compositionReferenceR5.value[x] | |
Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
Cardinality | 1...1 |
Type | Reference(UKCoreComposition) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:noteR5 | |
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. |
Cardinality | 0...1 |
Type | Extension(Annotation) |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:noteR5.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 |
|
DiagnosticReport.extension:noteR5.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 |
|
DiagnosticReport.extension:noteR5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note |
Mappings |
|
DiagnosticReport.extension:noteR5.value[x] | |
Definition | May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation. |
Cardinality | 1...1 |
Type | Annotation |
Invariants |
|
Mappings |
|
DiagnosticReport.extension:supportingInfoR5 | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
DiagnosticReport.extension:supportingInfoR5.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 |
|
DiagnosticReport.extension:supportingInfoR5.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 |
|
DiagnosticReport.extension:supportingInfoR5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo |
Mappings |
|
DiagnosticReport.extension:supportingInfoR5.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...1 |
Type | base64Binary |
Invariants |
|
Mappings |
|
DiagnosticReport.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
DiagnosticReport.identifier | |
Definition | Identifiers assigned to this Laboratory Report by the performer or other systems. It shall be common to several report versions |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Alias | ReportID, Filler ID, Placer ID |
Requirements | Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. |
Comments | Composition.identifier SHALL be equal to one of the DiagnosticReport.identifier, if at least one exists |
Invariants |
|
Mappings |
|
DiagnosticReport.basedOn | |
Definition | Details concerning a service requested. |
Cardinality | 0...* |
Type | Reference(ServiceRequestLabEu) |
Alias | Request |
Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. |
Comments | Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. |
Invariants |
|
Mappings |
|
DiagnosticReport.status | |
Definition | The status of the diagnostic report. |
Cardinality | 1...1 |
Type | code |
Binding | The status of the diagnostic report. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. |
Comments | DiagnosticReport.status and Composition.status shall be aligned, based on the http://hl7.eu/fhir/laboratory/ConceptMap/ConceptMap-eu-diagRptStatus2CompStatus mapping |
Invariants |
|
Mappings |
|
DiagnosticReport.category | |
Definition | A code that classifies this laboratory report. Two basic categories has been selected in this guide: laboratory specialty and Study type. Laboratory specialty is characteristic of the laboratory that produced the test result while Study type is an arbitrary classificion of the test type. |
Cardinality | 0...* |
Type | CodeableConceptIPS |
Binding | Codes for diagnostic service sections. |
Summary | True |
Alias | Department, Sub-department, Service, Discipline |
Comments | DiagnosticReport.category and Composition.category shall be aligned |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
DiagnosticReport.category:studyType | |
Definition | Laboratory services, i.e., results of tests performed, could be characterized using typology of services, commonly called study types. Study type could be seen as an attribute or grouping mechanism that assigns a common clinical sense to certain types of laboratory test results., e.g., Hemoglobin, Platelet count, etc. belongs to 'Hematology study'. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | LabStudyTypesEuVs (required) |
Summary | True |
Alias | Department, Sub-department, Service, Discipline |
Comments | In comparison to the laboratory specialty which is an attribute of laboratory, study type is a categorization of laboratory service. It needs to be mentioned that classification of test to study types in not standardized. |
Invariants |
|
Mappings |
|
DiagnosticReport.category:specialty | |
Definition | Laboratory specialty is an attribute of any laboratory setting representing professional qualification of the laboratory to execute certain kind of laboratory tests. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | LabSpecialtyEuVs (required) |
Summary | True |
Alias | Department, Sub-department, Service, Discipline |
Comments | Specialty could be used as parameter for searching/querying of laboratory test results. |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory | |
Definition | A code that classifies this laboratory report. Two basic categories has been selected in this guide: laboratory specialty and Study type. Laboratory specialty is characteristic of the laboratory that produced the test result while Study type is an arbitrary classificion of the test type. |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | Codes for diagnostic service sections. |
Must Support | True |
Summary | True |
Alias | Department, Sub-department, Service, Discipline |
Comments | DiagnosticReport.category and Composition.category shall be aligned |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory.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 |
|
DiagnosticReport.category:laboratory.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 |
|
DiagnosticReport.category:laboratory.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | CodingIPS |
Must Support | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory.coding.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 |
|
DiagnosticReport.category:laboratory.coding.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 |
|
DiagnosticReport.category:laboratory.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Must Support | True |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0074 |
Mappings |
|
DiagnosticReport.category:laboratory.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Must Support | True |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Fixed Value | LAB |
Mappings |
|
DiagnosticReport.category:laboratory.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory.coding.display.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
DiagnosticReport.category:laboratory.coding.display.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
DiagnosticReport.category:laboratory.coding.display.extension:translation | |
Definition | Language translation from base language of resource to another language. |
Cardinality | 0...* |
Type | Extension(Complex) |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory.coding.display.value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.String |
DiagnosticReport.category:laboratory.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
DiagnosticReport.category:laboratory.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
DiagnosticReport.code | |
Definition | Specifies that it refers to a Laboratory Report |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | UKCoreReportCode (preferred) |
Must Support | True |
Summary | True |
Alias | Type |
Comments | At least one DiagnosticReport.code.coding and Composition.type.coding SHALL be equal |
Invariants |
|
Mappings |
|
DiagnosticReport.subject | |
Definition | Who or what this report is about. The report can be about a human patient, a living subject, a device (e.g. a machine), a location or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure). |
Cardinality | 1...1 |
Type | Reference(PatientEuLab | PatientAnimalEu | Group | Location | Device) |
Summary | True |
Alias | Patient |
Requirements | SHALL know the subject context. |
Comments | DiagnosticReport and Composition SHALL have the same subject |
Invariants |
|
Mappings |
|
DiagnosticReport.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | Context |
Requirements | Links the request to the Encounter context. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). DiagnosticReport and Composition SHALL have the same encounter. |
Invariants |
|
Mappings |
|
DiagnosticReport.effective[x] | |
Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | Observation time, Effective Time, Occurrence |
Requirements | Need to know where in the patient history to file/present this report. |
Comments | If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. |
Invariants |
|
Mappings |
|
DiagnosticReport.issued | |
Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
Cardinality | 0...1 |
Type | instant |
Must Support | True |
Summary | True |
Alias | Date published, Date Issued, Date Verified |
Requirements | Clinicians need to be able to check the date that the report was released. |
Comments | May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer | |
Definition | The diagnostic service that is responsible for issuing the report. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
Summary | True |
Alias | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
Comments | If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.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 |
|
DiagnosticReport.performer.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 |
|
DiagnosticReport.performer.extension:deviceReference | |
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport |
Cardinality | 0...1 |
Type | Extension(Reference(UKCoreDevice)) |
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 |
|
DiagnosticReport.performer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
DiagnosticReport.performer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter | |
Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam) |
Summary | True |
Alias | Analyzed by, Reported by |
Requirements | Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. |
Comments | If a DiagnosticReport.resultsInterpreter exists this is expected to be a Composition.author; otherwise a DiagnosticReport.performer should be an author. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.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 |
|
DiagnosticReport.resultsInterpreter.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 |
|
DiagnosticReport.resultsInterpreter.extension:deviceReference | |
Definition | An additional Device reference for a DiagnosticReport, to allow Software as a Medical Device to perform / interpret a DiagnosticReport |
Cardinality | 0...* |
Type | Extension(Reference(UKCoreDevice)) |
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 |
|
DiagnosticReport.resultsInterpreter.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
DiagnosticReport.resultsInterpreter.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
DiagnosticReport.specimen | |
Definition | Details about the specimens on which this diagnostic report is based. |
Cardinality | 0...* |
Type | Reference(SpecimenEu) |
Requirements | Need to be able to report information about the collected specimens on which the report is based. |
Comments | If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. |
Invariants |
|
Mappings |
|
DiagnosticReport.result | |
Definition | [Observations](http://hl7.org/fhir/R4/observation.html) that are part of this diagnostic report. |
Cardinality | 0...* |
Type | Reference(ObservationResultsLaboratoryEu) |
Must Support | True |
Alias | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer |
Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. |
Comments | Observations can contain observations. |
Invariants |
|
Mappings |
|
DiagnosticReport.imagingStudy | |
Definition | One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images. |
Cardinality | 0...0 |
Type | Reference(ImagingStudy) |
Comments | ImagingStudy and the image element are somewhat overlapping - typically, the list of image references in the image element will also be found in one of the imaging study resources. However, each caters to different types of displays for different types of purposes. Neither, either, or both may be provided. |
Invariants |
|
Mappings |
|
DiagnosticReport.media | |
Definition | A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Alias | DICOM, Slides, Scans |
Requirements | Many diagnostic services include images in the report as part of their service. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.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 |
|
DiagnosticReport.media.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. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
DiagnosticReport.media.comment | |
Definition | A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. |
Cardinality | 0...1 |
Type | string |
Requirements | The provider of the report should make a comment about each image included in the report. |
Comments | The comment should be displayed with the image. It would be common for the report to include additional discussion of the image contents in other sections such as the conclusion. |
Invariants |
|
Mappings |
|
DiagnosticReport.media.link | |
Definition | Reference to the image source. |
Cardinality | 1...1 |
Type | Reference(Media) |
Summary | True |
Invariants |
|
Mappings |
|
DiagnosticReport.conclusion | |
Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
Cardinality | 0...1 |
Type | string |
Alias | Report |
Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. |
Invariants |
|
Mappings |
|
DiagnosticReport.conclusionCode | |
Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Diagnosis codes provided as adjuncts to the report. |
Invariants |
|
Mappings |
|
DiagnosticReport.presentedForm | |
Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. |
Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. |
Invariants |
|
Mappings |
|
Table View
DiagnosticReport | .. | |
DiagnosticReport.extension | Extension | ..1 |
DiagnosticReport.extension.value[x] | .. | |
DiagnosticReport.extension | Extension | .. |
DiagnosticReport.extension.value[x] | .. | |
DiagnosticReport.extension | Extension | .. |
DiagnosticReport.extension.extension | 2.. | |
DiagnosticReport.status | .. | |
DiagnosticReport.category | 1..1 | |
DiagnosticReport.category.coding | .. | |
DiagnosticReport.category.coding.system | .. | |
DiagnosticReport.category.coding.code | .. | |
DiagnosticReport.code | .. | |
DiagnosticReport.issued | .. | |
DiagnosticReport.performer | .. | |
DiagnosticReport.performer.extension | Extension | ..1 |
DiagnosticReport.resultsInterpreter | .. | |
DiagnosticReport.resultsInterpreter.extension | Extension | .. |
DiagnosticReport.result | .. | |
DiagnosticReport.conclusionCode | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-DiagnosticReport-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport-Lab" /> <version value="2.0.1" /> <name value="UKCoreDiagnosticReportLab" /> <title value="UK Core Diagnostic Report Lab" /> <status value="active" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [DiagnosticReport](https://hl7.org/fhir/R4/DiagnosticReport.html), to provide laboratory specific support for test results." /> <purpose value="To provide implementers with additional support when implementing test result data and to provide a consistent structure to how the data is presented." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="DiagnosticReport" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/DiagnosticReport-eu-lab" /> <derivation value="constraint" /> <differential> <element id="DiagnosticReport"> <path value="DiagnosticReport" /> <constraint> <key value="ukcore-diag-lab-001" /> <severity value="warning" /> <human value="An issued time SHOULD be present if status = partial, preliminary, final, amended, corrected or appended" /> <expression value="issued.exists() or (issued.empty() and (status in ('partial' | 'preliminary' | 'final' | 'amended' | 'corrected' | 'appended')).not())" /> </constraint> </element> <element id="DiagnosticReport.extension:compositionReferenceR5"> <path value="DiagnosticReport.extension" /> <sliceName value="compositionReferenceR5" /> <short value="A Composition reference for a DiagnosticReport. This is a R5 backport." /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:compositionReferenceR5.value[x]"> <path value="DiagnosticReport.extension.value[x]" /> <short value="Reference to a Composition resource." /> <definition value="Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." /> </element> <element id="DiagnosticReport.extension:noteR5"> <path value="DiagnosticReport.extension" /> <sliceName value="noteR5" /> <short value="Comments about the diagnostic report. This is a R5 backport." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:noteR5.value[x]"> <path value="DiagnosticReport.extension.value[x]" /> <definition value="May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation." /> </element> <element id="DiagnosticReport.extension:supportingInfoR5"> <path value="DiagnosticReport.extension" /> <sliceName value="supportingInfoR5" /> <short value="Additional info supporting the diagnostic report. This is a R5 backport." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.extension:supportingInfoR5.extension"> <path value="DiagnosticReport.extension.extension" /> <min value="2" /> </element> <element id="DiagnosticReport.status"> <path value="DiagnosticReport.status" /> <short value="The status of the diagnostic report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.category:laboratory"> <path value="DiagnosticReport.category" /> <sliceName value="laboratory" /> <short value="A mandatory slice that states this resource is categorized as laboratory related content." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.category:laboratory.coding.system"> <path value="DiagnosticReport.category.coding.system" /> <fixedUri value="http://terminology.hl7.org/CodeSystem/v2-0074" /> </element> <element id="DiagnosticReport.category:laboratory.coding.code"> <path value="DiagnosticReport.category.coding.code" /> <fixedCode value="LAB" /> </element> <element id="DiagnosticReport.code"> <path value="DiagnosticReport.code" /> <short value="A code or name that describes this diagnostic report." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode" /> </binding> </element> <element id="DiagnosticReport.issued"> <path value="DiagnosticReport.issued" /> <short value="Clinically relevant time / time-period for report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.performer.extension:deviceReference"> <path value="DiagnosticReport.performer.extension" /> <sliceName value="deviceReference" /> <short value="A reference to a Device which interprets / performs the results of the DiagnosticReport." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.resultsInterpreter.extension:deviceReference"> <path value="DiagnosticReport.resultsInterpreter.extension" /> <sliceName value="deviceReference" /> <short value="A reference to a Device which interprets / performs the results of the DiagnosticReport." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" /> </type> <isModifier value="false" /> </element> <element id="DiagnosticReport.result"> <path value="DiagnosticReport.result" /> <short value="Lab related Observations that are part of this diagnostic report." /> <mustSupport value="true" /> </element> <element id="DiagnosticReport.conclusionCode"> <path value="DiagnosticReport.conclusionCode" /> <binding> <strength value="preferred" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-DiagnosticReport-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-DiagnosticReport-Lab", "version": "2.0.1", "name": "UKCoreDiagnosticReportLab", "title": "UK Core Diagnostic Report Lab", "status": "active", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [DiagnosticReport](https://hl7.org/fhir/R4/DiagnosticReport.html), to provide laboratory specific support for test results.", "purpose": "To provide implementers with additional support when implementing test result data and to provide a consistent structure to how the data is presented.", "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", "kind": "resource", "abstract": false, "type": "DiagnosticReport", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/DiagnosticReport-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "DiagnosticReport", "path": "DiagnosticReport", "constraint": [ { "key": "ukcore-diag-lab-001", "severity": "warning", "human": "An issued time SHOULD be present if status = partial, preliminary, final, amended, corrected or appended", "expression": "issued.exists() or (issued.empty() and (status in ('partial' | 'preliminary' | 'final' | 'amended' | 'corrected' | 'appended')).not())" } ] }, { "id": "DiagnosticReport.extension:compositionReferenceR5", "path": "DiagnosticReport.extension", "sliceName": "compositionReferenceR5", "short": "A Composition reference for a DiagnosticReport. This is a R5 backport.", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:compositionReferenceR5.value[x]", "path": "DiagnosticReport.extension.value[x]", "short": "Reference to a Composition resource.", "definition": "Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport." }, { "id": "DiagnosticReport.extension:noteR5", "path": "DiagnosticReport.extension", "sliceName": "noteR5", "short": "Comments about the diagnostic report. This is a R5 backport.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:noteR5.value[x]", "path": "DiagnosticReport.extension.value[x]", "definition": "May include general statements about the diagnostic report, or statements about significant, unexpected or unreliable results values contained within the diagnostic report, or information about its source when relevant to its interpretation." }, { "id": "DiagnosticReport.extension:supportingInfoR5", "path": "DiagnosticReport.extension", "sliceName": "supportingInfoR5", "short": "Additional info supporting the diagnostic report. This is a R5 backport.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo" ] } ], "isModifier": false }, { "id": "DiagnosticReport.extension:supportingInfoR5.extension", "path": "DiagnosticReport.extension.extension", "min": 2 }, { "id": "DiagnosticReport.status", "path": "DiagnosticReport.status", "short": "The status of the diagnostic report.", "mustSupport": true }, { "id": "DiagnosticReport.category:laboratory", "path": "DiagnosticReport.category", "sliceName": "laboratory", "short": "A mandatory slice that states this resource is categorized as laboratory related content.", "min": 1, "max": "1", "mustSupport": true }, { "id": "DiagnosticReport.category:laboratory.coding.system", "path": "DiagnosticReport.category.coding.system", "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0074" }, { "id": "DiagnosticReport.category:laboratory.coding.code", "path": "DiagnosticReport.category.coding.code", "fixedCode": "LAB" }, { "id": "DiagnosticReport.code", "path": "DiagnosticReport.code", "short": "A code or name that describes this diagnostic report.", "mustSupport": true, "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ReportCode" } }, { "id": "DiagnosticReport.issued", "path": "DiagnosticReport.issued", "short": "Clinically relevant time / time-period for report.", "mustSupport": true }, { "id": "DiagnosticReport.performer.extension:deviceReference", "path": "DiagnosticReport.performer.extension", "sliceName": "deviceReference", "short": "A reference to a Device which interprets / performs the results of the DiagnosticReport.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" ] } ], "isModifier": false }, { "id": "DiagnosticReport.resultsInterpreter.extension:deviceReference", "path": "DiagnosticReport.resultsInterpreter.extension", "sliceName": "deviceReference", "short": "A reference to a Device which interprets / performs the results of the DiagnosticReport.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeviceReference" ] } ], "isModifier": false }, { "id": "DiagnosticReport.result", "path": "DiagnosticReport.result", "short": "Lab related Observations that are part of this diagnostic report.", "mustSupport": true }, { "id": "DiagnosticReport.conclusionCode", "path": "DiagnosticReport.conclusionCode", "binding": { "strength": "preferred" } } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-Lab | active | 2.0.1 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource Observation, in order to represent an individual laboratory test and result value. These tests can be grouped together using the UKCore-Observation-Group-Lab profile. |
Profile_Purpose |
---|
To provide the minimum expectations for each individual laboratory test. |
Detailed Descriptions
Observation | |
Definition | This observation may represent the result of a simple laboratory test such as hematocrit or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and references the atomic results of the study as "has-member" child observations |
Cardinality | 0...* |
Alias | Vital Signs, Measurement, Results, Tests |
Comments | Represents either a lab simple observation or the group of observations produced by a laboratory study. |
Invariants |
|
Mappings |
|
Observation.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Observation.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Observation.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Observation.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Observation.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Observation.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Observation.extension | |
Definition | The laboratory test kit used for this test. |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.extension:supportingInfo | |
Definition | Other resources *from the patient record* that may be relevant to the event. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension **should not** be used if more specific inline elements or extensions are available. For example, use `Observation.hasMember` instead of supportingInformation for representing the members of an Observation panel. |
Cardinality | 0...* |
Type | Extension(Reference(Resource)) |
Invariants |
|
Observation.extension:triggeredBy-r5 | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...* |
Type | Extension(Complex) |
Invariants |
|
Mappings |
|
Observation.extension:triggeredBy-r5.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 |
|
Observation.extension:triggeredBy-r5.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 |
|
Observation.extension:triggeredBy-r5.extension:observation | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
Observation.extension:triggeredBy-r5.extension:observation.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 |
|
Observation.extension:triggeredBy-r5.extension:observation.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.extension:triggeredBy-r5.extension:observation.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 | observation |
Mappings |
|
Observation.extension:triggeredBy-r5.extension:observation.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(Observation) |
Invariants |
|
Mappings |
|
Observation.extension:triggeredBy-r5.extension:type | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
Observation.extension:triggeredBy-r5.extension:type.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 |
|
Observation.extension:triggeredBy-r5.extension:type.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.extension:triggeredBy-r5.extension:type.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 | type |
Mappings |
|
Observation.extension:triggeredBy-r5.extension:type.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | code |
Invariants |
|
Mappings |
|
Observation.extension:triggeredBy-r5.extension:reason | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
Observation.extension:triggeredBy-r5.extension:reason.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 |
|
Observation.extension:triggeredBy-r5.extension:reason.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.extension:triggeredBy-r5.extension:reason.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 | reason |
Mappings |
|
Observation.extension:triggeredBy-r5.extension:reason.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
Observation.extension:triggeredBy-r5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy |
Mappings |
|
Observation.extension:triggeredBy-r5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Observation.extension:certifiedRefMaterialCodeable | |
Definition | This extension links this observation with the certified reference material used for the calibration. The certified reference material is identified by using a CodeableConcept. This extension should be used when the unit is UCUM [IU]. |
Cardinality | 0...* |
Type | Extension(CodeableConcept) |
Invariants |
|
Observation.extension:certifiedRefMaterialIdentifer | |
Definition | This extension links this observation with the certified reference material used for the calibration. The certified reference material is identified by using an Identifier. This extension should be used when the unit is UCUM [IU]. |
Cardinality | 0...* |
Type | Extension(Identifier) |
Invariants |
|
Observation.extension:labTestKit | |
Definition | This extension links this observation with the laboratory test kit used for this test. Usually only one laboratory test kit is referred |
Cardinality | 0...* |
Type | Extension(Reference(Device)) |
Invariants |
|
Observation.extension:value-r5 | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Mappings |
|
Observation.extension:value-r5.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 |
|
Observation.extension:value-r5.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.extension:value-r5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] |
Mappings |
|
Observation.extension:value-r5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Attachment |
Invariants |
|
Mappings |
|
Observation.extension:triggeredByR5 | |
Definition | Identifies the observation(s) that triggered the performance of this observation. |
Cardinality | 0...* |
Type | Extension(Complex) |
Invariants |
|
Mappings |
|
Observation.extension:triggeredByR5.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 |
|
Observation.extension:triggeredByR5.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 |
|
Observation.extension:triggeredByR5.extension:observation | |
Definition | Reference to the triggering observation. |
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 |
|
Observation.extension:triggeredByR5.extension:observation.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 |
|
Observation.extension:triggeredByR5.extension:observation.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...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 |
|
Observation.extension:triggeredByR5.extension:observation.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 | observation |
Mappings |
|
Observation.extension:triggeredByR5.extension:observation.value[x] | |
Definition | A reference to the triggering observation. |
Cardinality | 1...1 |
Type | Reference(Observation) |
Invariants |
|
Mappings |
|
Observation.extension:triggeredByR5.extension:type | |
Definition | The type of trigger. Reflex | Repeat | Re-run. |
Cardinality | 1...1 |
Type | Extension |
Binding | TriggeredBytype (required) |
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 |
|
Observation.extension:triggeredByR5.extension:type.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 |
|
Observation.extension:triggeredByR5.extension:type.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...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 |
|
Observation.extension:triggeredByR5.extension:type.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 | type |
Mappings |
|
Observation.extension:triggeredByR5.extension:type.value[x] | |
Definition | The type of trigger. Reflex | Repeat | Re-run |
Cardinality | 1...1 |
Type | code |
Invariants |
|
Mappings |
|
Observation.extension:triggeredByR5.extension:reason | |
Definition | Provides the reason why this observation was performed as a result of the observation(s) referenced. |
Cardinality | 0...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 |
|
Observation.extension:triggeredByR5.extension:reason.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 |
|
Observation.extension:triggeredByR5.extension:reason.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...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 |
|
Observation.extension:triggeredByR5.extension:reason.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 | reason |
Mappings |
|
Observation.extension:triggeredByR5.extension:reason.value[x] | |
Definition | Provides the reason why this observation was performed as a result of the observation referenced. |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
Observation.extension:triggeredByR5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy |
Mappings |
|
Observation.extension:triggeredByR5.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 |
|
Observation.extension:bodyStructureR5 | |
Definition | The laboratory test kit used for this test. |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
Observation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Observation.identifier | |
Definition | A unique identifier assigned to this observation. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows observations to be distinguished and referenced. |
Invariants |
|
Mappings |
|
Observation.basedOn | |
Definition | A plan, proposal or order that is fulfilled in whole or in part by this event. For example, a MedicationRequest may require a patient to have laboratory test performed before it is dispensed. |
Cardinality | 0...* |
Type | Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) |
Summary | True |
Alias | Fulfills |
Requirements | Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon. |
Invariants |
|
Mappings |
|
Observation.partOf | |
Definition | A larger event of which this particular Observation is a component or step. For example, an observation as part of a procedure. |
Cardinality | 0...* |
Type | Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) |
Summary | True |
Alias | Container |
Comments | To link an Observation to an Encounter use |
Invariants |
|
Mappings |
|
Observation.status | |
Definition | The status of the result value. |
Cardinality | 1...1 |
Type | code |
Binding | Codes providing the status of an observation. |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to track the status of individual results. Some results are finalized before the whole report is finalized. |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Observation.category | |
Definition | A code that classifies the general type of observation being made. |
Cardinality | 1...* |
Type | CodeableConceptIPS |
Binding | Codes for high level observation categories. |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | "laboratory" includes laboratory medicine and pathology |
Slicing | Unordered, Open, by $this(Value) |
Invariants |
|
Mappings |
|
Observation.category:laboratory | |
Definition | A code that classifies the general type of observation being made. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes for high level observation categories. |
Must Support | True |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Pattern | { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "laboratory" } ] } |
Mappings |
|
Observation.category:laboratory.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 |
|
Observation.category:laboratory.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 |
|
Observation.category:laboratory.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Pattern | { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "laboratory" } |
Mappings |
|
Observation.category:laboratory.coding.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 |
|
Observation.category:laboratory.coding.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 |
|
Observation.category:laboratory.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/observation-category |
Mappings |
|
Observation.category:laboratory.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Observation.category:laboratory.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Fixed Value | laboratory |
Mappings |
|
Observation.category:laboratory.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Observation.category:laboratory.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Observation.category:laboratory.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Observation.category:studyType | |
Definition | A code that classifies the general type of observation being made. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | LabStudyTypesEuVs (required) |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
Observation.category:specialty | |
Definition | A code that classifies the general type of observation being made. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | LabSpecialtyEuVs (required) |
Requirements | Used for filtering what observations are retrieved and displayed. |
Comments | In addition to the required category valueset, this element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used at once. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
Observation.code | |
Definition | Describes what was observed. Sometimes this is called the observation "name". In this profile this code represents either a simple laboratory test or a laboratory study with multiple child observations |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | A code from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test results |
Must Support | True |
Summary | True |
Alias | Name |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | In the context of this Observation-laboratory-uv-ips profile, when the observation plays the role of a grouper of member sub-observations, the code represent the group (for instance a panel code). In case no code is available, at least a text shall be provided. |
Invariants |
|
Mappings |
|
Observation.subject | |
Definition | The patient, or group of patients, location, or device this observation is about and into whose record the observation is placed. If the actual focus of the observation is different from the subject (or a sample of, part, or region of the subject), the `focus` element or the `code` itself specifies the actual focus of the observation. |
Cardinality | 1...1 |
Type | Reference(PatientAnimalEu | PatientEuLab | Group | Device | Location) |
Summary | True |
Requirements | Observations have no value if you don't know who or what they're about. |
Comments | One would expect this element to be a cardinality of 1..1. The only circumstance in which the subject can be missing is when the observation is made by a device that does not know the patient. In this case, the observation SHALL be matched to a patient through some context/channel matching technique, and at this point, the observation should be updated. |
Invariants |
|
Mappings |
|
Observation.subject.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 |
|
Observation.subject.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 |
|
Observation.subject.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Observation.subject.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Observation.subject.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Observation.subject.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Observation.focus | |
Definition | The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus. |
Cardinality | 0...* |
Type | Reference(Resource) |
Summary | True |
Comments | Typically, an observation is made about the subject - a patient, or group of patients, location, or device - and the distinction between the subject and what is directly measured for an observation is specified in the observation code itself ( e.g., "Blood Glucose") and does not need to be represented separately using this element. Use |
Invariants |
|
Mappings |
|
Observation.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | Context |
Requirements | For some observations it may be important to know the link between an observation and a particular encounter. |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). |
Invariants |
|
Mappings |
|
Observation.effective[x] | |
Definition | The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Alias | Occurrence |
Requirements | Knowing when an observation was deemed true is important to its relevance as well as determining trends. |
Comments | At least a date should be present unless this observation is a historical report. For recording imprecise or "fuzzy" times (For example, a blood glucose measurement taken "after breakfast") use the Timing datatype which allow the measurement to be tied to regular life events. |
Invariants |
|
Mappings |
|
Observation.effective[x].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 |
|
Observation.effective[x].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 |
|
Observation.effective[x].extension:data-absent-reason | |
Definition | Provides a reason why the effectiveTime is missing. |
Cardinality | 0...1 |
Type | Extension(code) |
Invariants |
|
Mappings |
|
Observation.issued | |
Definition | The date and time this version of the observation was made available to providers, typically after the results have been reviewed and verified. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | For Observations that don’t require review and verification, it may be the same as the |
Invariants |
|
Mappings |
|
Observation.performer | |
Definition | Who was responsible for asserting the observed value as "true". |
Cardinality | 1...* |
Type | Reference(PractitionerRoleEu | PractitionerEu | OrganizationUvIps | CareTeam | PatientEuLab | RelatedPerson) |
Summary | True |
Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. |
Invariants |
|
Mappings |
|
Observation.performer.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 |
|
Observation.performer.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 |
|
Observation.performer.extension:performerFunction | |
Definition | Distinguishes the type of involvement of the performer in the event. For example, 'author', 'verifier' or 'responsible party'. |
Cardinality | 0...* |
Type | Extension(CodeableConcept) |
Invariants |
|
Mappings |
|
Observation.performer.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
Observation.performer.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Observation.performer.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Observation.performer.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Observation.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.value[x]:valueString | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueRange | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | RangeIPS |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueRatio | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | RatioEuLab |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueTime | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | time |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueDateTime | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valuePeriod | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueQuantity | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | QuantityEuLab |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.value[x]:valueCodeableConcept | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | CodeableConceptIPS |
Binding | ResultsCodedValuesLaboratoryUvIps (preferred) |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | An observation may have; 1) a single value here, 2) both a value and a set of related or component values, or 3) only a set of related or component values. If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.value[x] is missing. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes specifying why the result ( |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | Null or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "specimen unsatisfactory". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Note that an observation may only be reported if there are values to report. For example differential cell counts values may be reported only when > 0. Because of these options, use-case agreements are required to interpret general observations for null or exceptional values. |
Invariants |
|
Mappings |
|
Observation.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Cardinality | 0...* |
Type | CodeableConceptIPS |
Binding | Codes identifying interpretations of observations. |
Alias | Abnormal Flag |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Comments | Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. |
Invariants |
|
Mappings |
|
Observation.note | |
Definition | Comments about the observation or the results. |
Cardinality | 0...* |
Type | Annotation |
Requirements | Need to be able to provide free text additional information. |
Comments | May include general statements about the observation, or statements about significant, unexpected or unreliable results values, or information about its source when relevant to its interpretation. |
Invariants |
|
Mappings |
|
Observation.bodySite | |
Definition | Indicates the site on the subject's body where the observation was made (i.e. the target site). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Comments | Only used if not implicit in code found in Observation.code. In many systems, this may be represented as a related observation instead of an inline component. If the use case requires BodySite to be handled as a separate resource (e.g. to identify and track separately) then use the standard extension bodySite. |
Invariants |
|
Mappings |
|
Observation.method | |
Definition | Laboratory technigue that has been used |
Cardinality | 0...1 |
Type | CodeableConceptIPS |
Binding | LabTechniqueEuVs (preferred) |
Requirements | In some cases, method can impact results and is thus used for determining whether results can be compared or determining significance of results. |
Comments | Laboratory technique (method of measurement) are integral parts of the test specification of some laboratory test coding systems (e.g. NPU), in LOINC hovewer measurement principle is not always present in the test definition. In some cases however knowledge of the used measurment techique is important for proper interpretation of the test result. That's why it is important to explicitly include informaiton about measurement method is such cases. |
Invariants |
|
Mappings |
|
Observation.specimen | |
Definition | The specimen that was used when this observation was made. |
Cardinality | 0...1 |
Type | Reference(SpecimenEu) |
Comments | When the specimen is applicable and known it shall be documented |
Invariants |
|
Mappings |
|
Observation.device | |
Definition | The device used to generate the observation data. |
Cardinality | 0...1 |
Type | Reference(Device | DeviceMetric) |
Comments | Note that this is not meant to represent a device involved in the transmission of the result, e.g., a gateway. Such devices may be documented using the Provenance resource where relevant. |
Invariants |
|
Mappings |
|
Observation.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. Multiple reference ranges are interpreted as an "OR". In other words, to represent two distinct target populations, two `referenceRange` elements would be used. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Invariants |
|
Mappings |
|
Observation.referenceRange.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 |
|
Observation.referenceRange.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. |
Invariants |
|
Mappings |
|
Observation.referenceRange.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Observation.referenceRange.low | |
Definition | The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3). |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
Observation.referenceRange.high | |
Definition | The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3). |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
Observation.referenceRange.type | |
Definition | Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Code for the meaning of a reference range. |
Requirements | Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, etc., - for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal range is assumed. |
Invariants |
|
Mappings |
|
Observation.referenceRange.appliesTo | |
Definition | Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race. Multiple `appliesTo` are interpreted as an "AND" of the target populations. For example, to represent a target population of African American females, both a code of female and a code for African American would be used. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying the population the reference range applies to. |
Requirements | Need to be able to identify the target population for proper interpretation. |
Comments | This SHOULD be populated if there is more than one range. If this element is not present then the normal population is assumed. |
Invariants |
|
Mappings |
|
Observation.referenceRange.age | |
Definition | The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so. |
Cardinality | 0...1 |
Type | Range |
Requirements | Some analytes vary greatly over age. |
Invariants |
|
Mappings |
|
Observation.referenceRange.text | |
Definition | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of "normals". |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Observation.hasMember | |
Definition | A reference to another Observation profiled by Observation-results-laboratory-uv-ips. The target observation (for instance an individual test member of a panel) is considered as a sub-observation of the current one, which plays the role of a grouper. |
Cardinality | 0...* |
Type | Reference(ObservationResultsLaboratoryEu) |
Summary | True |
Comments | This element is used in the context of international patient summary when there is a need to group a collection of observations, because they belong to the same panel, or because they share a common interpretation comment, or a common media attachment (illustrative image or graph). In these cases, the current observation is the grouper, and its set of sub-observations are related observations using the type "has-member". For a discussion on the ways Observations can be assembled in groups together see Observation Grouping. |
Invariants |
|
Mappings |
|
Observation.derivedFrom | |
Definition | The target resource that represents a measurement from which this observation value is derived. For example, a calculated anion gap or a fetal measurement based on an ultrasound image. |
Cardinality | 0...* |
Type | Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) |
Summary | True |
Comments | All the reference choices that are listed in this element can represent clinical observations and other measurements that may be the source for a derived value. The most common reference will be another Observation. For a discussion on the ways Observations can assembled in groups together, see Notes below. |
Invariants |
|
Mappings |
|
Observation.component | |
Definition | Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Requirements | Component observations share the same attributes in the Observation resource as the primary observation and are always treated a part of a single observation (they are not separable). However, the reference range for the primary observation value is not inherited by the component values and is required when appropriate for each component observation. |
Comments | For a discussion on the ways Observations can be assembled in groups together see Notes below. |
Invariants |
|
Mappings |
|
Observation.component.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 |
|
Observation.component.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.component.extension:value-r5 | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Mappings |
|
Observation.component.extension:value-r5.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 |
|
Observation.component.extension:value-r5.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Observation.component.extension:value-r5.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 | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] |
Mappings |
|
Observation.component.extension:value-r5.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Attachment |
Invariants |
|
Mappings |
|
Observation.component.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Observation.component.code | |
Definition | Describes what was observed. Sometimes this is called the observation "code". |
Cardinality | 1...1 |
Type | CodeableConceptIPS |
Binding | ResultsLaboratoryObservationUvIps (preferred) |
Summary | True |
Requirements | Knowing what kind of observation is being made is essential to understanding the observation. |
Comments | All code-value and component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation. |
Invariants |
|
Mappings |
|
Observation.component.value[x] | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueString | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueRange | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | RangeIPS |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueRatio | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | RatioEuLab |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueTime | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | time |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueDateTime | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valuePeriod | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueQuantity | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | QuantityEuLab |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.value[x]:valueCodeableConcept | |
Definition | The information determined as a result of making the observation, if the information has a simple value. |
Cardinality | 0...1 |
Type | CodeableConceptIPS |
Binding | ResultsCodedValuesLaboratoryUvIps (preferred) |
Summary | True |
Requirements | An observation exists to have a value, though it might not if it is in error, or if it represents a group of observations. |
Comments | Used when observation has a set of component observations. An observation may have both a value (e.g. an Apgar score) and component observations (the observations from which the Apgar score was derived). If a value is present, the datatype for this element should be determined by Observation.code. A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Observation.code defines a coded value. For additional guidance, see the Notes section below. |
Invariants |
|
Mappings |
|
Observation.component.dataAbsentReason | |
Definition | Provides a reason why the expected value in the element Observation.component.value[x] is missing. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes specifying why the result ( |
Requirements | For many results it is necessary to handle exceptional values in measurements. |
Comments | "Null" or exceptional values can be represented two ways in FHIR Observations. One way is to simply include them in the value set and represent the exceptions in the value. For example, measurement values for a serology test could be "detected", "not detected", "inconclusive", or "test not done". The alternate way is to use the value element for actual observations and use the explicit dataAbsentReason element to record exceptional values. For example, the dataAbsentReason code "error" could be used when the measurement was not completed. Because of these options, use-case agreements are required to interpret general observations for exceptional values. |
Invariants |
|
Mappings |
|
Observation.component.interpretation | |
Definition | A categorical assessment of an observation value. For example, high, low, normal. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes identifying interpretations of observations. |
Alias | Abnormal Flag |
Requirements | For some results, particularly numeric results, an interpretation is necessary to fully understand the significance of a result. |
Comments | Historically used for laboratory results (known as 'abnormal flag' ), its use extends to other use cases where coded interpretations are relevant. Often reported as one or more simple compact codes this element is often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. |
Invariants |
|
Mappings |
|
Observation.component.referenceRange | |
Definition | Guidance on how to interpret the value by comparison to a normal or recommended range. |
Cardinality | 0...* |
Type | see (referenceRange) |
Requirements | Knowing what values are considered "normal" can help evaluate the significance of a particular result. Need to be able to provide multiple reference ranges for different contexts. |
Comments | Most observations only have one generic reference range. Systems MAY choose to restrict to only supplying the relevant reference range based on knowledge about the patient (e.g., specific to the patient's age, gender, weight and other factors), but this might not be possible or appropriate. Whenever more than one reference range is supplied, the differences between them SHOULD be provided in the reference range and/or age properties. |
Invariants |
|
Mappings |
|
Table View
Observation | .. | |
Observation.extension | Extension | .. |
Observation.extension.extension | .. | |
Observation.extension.extension.value[x] | .. | |
Observation.extension.extension | .. | |
Observation.extension.extension.value[x] | .. | |
Observation.extension.extension | .. | |
Observation.extension.extension.value[x] | .. | |
Observation.extension | Extension | .. |
Observation.status | .. | |
Observation.category | 1..1 | |
Observation.category.coding | .. | |
Observation.category.coding.system | .. | |
Observation.category.coding.code | .. | |
Observation.code | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Observation-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-Lab" /> <version value="2.0.1" /> <name value="UKCoreObservationLab" /> <title value="UK Core Observation Lab" /> <status value="active" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [Observation](https://hl7.org/fhir/R4/Observation.html), in order to represent an individual laboratory test and result value. These tests can be grouped together using the UKCore-Observation-Group-Lab profile." /> <purpose value="To provide the minimum expectations for each individual laboratory test." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="Observation" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/Observation-resultslab-eu-lab" /> <derivation value="constraint" /> <differential> <element id="Observation"> <path value="Observation" /> <constraint> <key value="ukcore-obs-lab-001" /> <severity value="warning" /> <human value="Either `value`, `dataAbsentReason` or `note` SHOULD be populated" /> <expression value="value.exists() or dataAbsentReason.exists() or note.exists()" /> </constraint> </element> <element id="Observation.extension:triggeredByR5"> <path value="Observation.extension" /> <sliceName value="triggeredByR5" /> <short value="Triggering observation(s). This is a R5 backport." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" /> </type> </element> <element id="Observation.extension:triggeredByR5.extension:observation"> <path value="Observation.extension.extension" /> <sliceName value="observation" /> </element> <element id="Observation.extension:triggeredByR5.extension:observation.value[x]"> <path value="Observation.extension.extension.value[x]" /> <short value="Triggering observation." /> <definition value="A reference to the triggering observation." /> </element> <element id="Observation.extension:triggeredByR5.extension:type"> <path value="Observation.extension.extension" /> <sliceName value="type" /> </element> <element id="Observation.extension:triggeredByR5.extension:type.value[x]"> <path value="Observation.extension.extension.value[x]" /> <short value="The type of trigger. Reflex | Repeat | Re-run" /> <definition value="The type of trigger. Reflex | Repeat | Re-run" /> </element> <element id="Observation.extension:triggeredByR5.extension:reason"> <path value="Observation.extension.extension" /> <sliceName value="reason" /> </element> <element id="Observation.extension:triggeredByR5.extension:reason.value[x]"> <path value="Observation.extension.extension.value[x]" /> <short value="Reason that the observation was triggered." /> <definition value="Provides the reason why this observation was performed as a result of the observation referenced." /> </element> <element id="Observation.extension:bodyStructureR5"> <path value="Observation.extension" /> <sliceName value="bodyStructureR5" /> <short value="Observed body structure. This is a R5 backport." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure" /> </type> </element> <element id="Observation.status"> <path value="Observation.status" /> <short value="The status of the result value." /> <mustSupport value="true" /> </element> <element id="Observation.category:laboratory"> <path value="Observation.category" /> <sliceName value="laboratory" /> <short value="A mandatory code, to identify this observation as being Lab related." /> <min value="1" /> <max value="1" /> <mustSupport value="true" /> </element> <element id="Observation.category:laboratory.coding.system"> <path value="Observation.category.coding.system" /> <fixedUri value="http://terminology.hl7.org/CodeSystem/observation-category" /> </element> <element id="Observation.category:laboratory.coding.code"> <path value="Observation.category.coding.code" /> <fixedCode value="laboratory" /> </element> <element id="Observation.code"> <path value="Observation.code" /> <short value="The type of lab related observation (code / type)." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <description value="A code from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test results" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineObservables" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Observation-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Observation-Lab", "version": "2.0.1", "name": "UKCoreObservationLab", "title": "UK Core Observation Lab", "status": "active", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Observation](https://hl7.org/fhir/R4/Observation.html), in order to represent an individual laboratory test and result value. These tests can be grouped together using the UKCore-Observation-Group-Lab profile.", "purpose": "To provide the minimum expectations for each individual laboratory test.", "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", "kind": "resource", "abstract": false, "type": "Observation", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/Observation-resultslab-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "Observation", "path": "Observation", "constraint": [ { "key": "ukcore-obs-lab-001", "severity": "warning", "human": "Either `value`, `dataAbsentReason` or `note` SHOULD be populated", "expression": "value.exists() or dataAbsentReason.exists() or note.exists()" } ] }, { "id": "Observation.extension:triggeredByR5", "path": "Observation.extension", "sliceName": "triggeredByR5", "short": "Triggering observation(s). This is a R5 backport.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy" ] } ] }, { "id": "Observation.extension:triggeredByR5.extension:observation", "path": "Observation.extension.extension", "sliceName": "observation" }, { "id": "Observation.extension:triggeredByR5.extension:observation.value[x]", "path": "Observation.extension.extension.value[x]", "short": "Triggering observation.", "definition": "A reference to the triggering observation." }, { "id": "Observation.extension:triggeredByR5.extension:type", "path": "Observation.extension.extension", "sliceName": "type" }, { "id": "Observation.extension:triggeredByR5.extension:type.value[x]", "path": "Observation.extension.extension.value[x]", "short": "The type of trigger. Reflex | Repeat | Re-run", "definition": "The type of trigger. Reflex | Repeat | Re-run" }, { "id": "Observation.extension:triggeredByR5.extension:reason", "path": "Observation.extension.extension", "sliceName": "reason" }, { "id": "Observation.extension:triggeredByR5.extension:reason.value[x]", "path": "Observation.extension.extension.value[x]", "short": "Reason that the observation was triggered.", "definition": "Provides the reason why this observation was performed as a result of the observation referenced." }, { "id": "Observation.extension:bodyStructureR5", "path": "Observation.extension", "sliceName": "bodyStructureR5", "short": "Observed body structure. This is a R5 backport.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.bodyStructure" ] } ] }, { "id": "Observation.status", "path": "Observation.status", "short": "The status of the result value.", "mustSupport": true }, { "id": "Observation.category:laboratory", "path": "Observation.category", "sliceName": "laboratory", "short": "A mandatory code, to identify this observation as being Lab related.", "min": 1, "max": "1", "mustSupport": true }, { "id": "Observation.category:laboratory.coding.system", "path": "Observation.category.coding.system", "fixedUri": "http://terminology.hl7.org/CodeSystem/observation-category" }, { "id": "Observation.category:laboratory.coding.code", "path": "Observation.category.coding.code", "fixedCode": "laboratory" }, { "id": "Observation.code", "path": "Observation.code", "short": "The type of lab related observation (code / type).", "mustSupport": true, "binding": { "strength": "preferred", "description": "A code from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test results", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineObservables" } } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient-Lab | draft | 2.6.1 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource Patient. |
Profile_Purpose |
---|
This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services. |
Detailed Descriptions
Patient | |
Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. |
Cardinality | 0...* |
Alias | SubjectOfCare Client Resident |
Invariants |
|
Mappings |
|
Patient.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Patient.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Patient.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Patient.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Patient.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Patient.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Patient.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.extension:birthPlace | |
Definition | The registered place of birth of the patient. |
Cardinality | 0...1 |
Type | Extension(Address) |
Invariants |
|
Patient.extension:birthPlace.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 | id |
Mappings |
|
Patient.extension:birthPlace.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.extension:birthPlace.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 | http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
Mappings |
|
Patient.extension:birthPlace.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | AddressEu |
Invariants |
|
Mappings |
|
Patient.extension:sex-for-clinical-use | |
Definition | A parameter that provides guidance on how a recipient should apply settings or reference ranges that are derived from observable information such as an organ inventory, recent hormone lab tests, genetic testing, menstrual status, obstetric history, etc.. |
Cardinality | 0...* |
Type | Extension(Complex) |
Invariants |
|
Patient.extension:birthSex | |
Definition | The patient's phenotypic sex at birth. |
Cardinality | 0...1 |
Type | Extension(code) |
Invariants |
|
Mappings |
|
Patient.extension:cadavericDonor | |
Definition | Flag indicating whether the patient authorized the donation of body parts after death. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Invariants |
|
Patient.extension:cadavericDonor.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 |
|
Patient.extension:cadavericDonor.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.extension:cadavericDonor.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 | http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor |
Mappings |
|
Patient.extension:cadavericDonor.value[x] | |
Definition | Flag indicating whether the patient authorized the donation of body parts after death. |
Cardinality | 1...1 |
Type | boolean |
Invariants |
|
Mappings |
|
Patient.extension:contactPreference | |
Definition | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. |
Cardinality | 0...1 |
Type | Extension(Complex) |
Invariants |
|
Mappings |
|
Patient.extension:deathNotificationStatus | |
Definition | The patient's death notification status. |
Cardinality | 0...1 |
Type | Extension(Complex) |
Invariants |
|
Mappings |
|
Patient.extension:ethnicCategory | |
Definition | The ethnicity of the subject. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Invariants |
|
Mappings |
|
Patient.extension:fetalStatus | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
Patient.extension:residentialStatus | |
Definition | The residential status of the patient. For example if this patient is a UK resident. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Invariants |
|
Mappings |
|
Patient.extension:patientInterpreterRequired | |
Definition | This Patient requires an interpreter to communicate healthcare information to the practitioner. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Comments | The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required. |
Invariants |
|
Patient.extension:patientInterpreterRequired.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 |
|
Patient.extension:patientInterpreterRequired.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.extension:patientInterpreterRequired.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 | http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
Mappings |
|
Patient.extension:patientInterpreterRequired.value[x] | |
Definition | Indicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner. |
Cardinality | 1...1 |
Type | boolean |
Invariants |
|
Mappings |
|
Patient.extension:nhsNumberUnavailableReason | |
Definition | The reason why a patient does not have an NHS Number. For example if this patient is an overseas patient. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Invariants |
|
Mappings |
|
Patient.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Patient.identifier | |
Definition | An identifier for this patient. |
Cardinality | 0...* |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Patients are almost always assigned specific numerical identifiers. |
Slicing | Unordered, Open, by system(Value) |
Invariants |
|
Mappings |
|
Patient.identifier:nhsNumber | |
Definition | An identifier for this patient. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | Patients are almost always assigned specific numerical identifiers. |
Invariants |
|
Mappings |
|
Patient.identifier:nhsNumber.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 |
|
Patient.identifier:nhsNumber.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 |
|
Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus | |
Definition | The verification/tracing status of the NHS number. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
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 |
|
Patient.identifier:nhsNumber.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Patient.identifier:nhsNumber.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Patient.identifier:nhsNumber.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Fixed Value | https://fhir.nhs.uk/Id/nhs-number |
Mappings |
|
Patient.identifier:nhsNumber.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Patient.identifier:nhsNumber.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Patient.identifier:nhsNumber.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Patient.active | |
Definition | Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. |
Comments | If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. |
Invariants |
|
Mappings |
|
Patient.name | |
Definition | A name associated with the individual. |
Cardinality | 1...* |
Type | HumanNameEu |
Must Support | True |
Summary | True |
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided |
Comments | A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. |
Invariants |
|
Mappings |
|
Patient.name.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 |
|
Patient.name.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 |
|
Patient.name.extension:name-absent-reason | |
Definition | Reason for not providing the name |
Cardinality | 0...* |
Type | Extension(code) |
Invariants |
|
Mappings |
|
Patient.name.use | |
Definition | Identifies the purpose for this name. |
Cardinality | 0...1 |
Type | code |
Binding | The use of a human name. |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Patient.name.text | |
Definition | Text representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Mappings |
|
Patient.name.family | |
Definition | Family name. When more the family is composed by more than one names, this element documents the full composed family name with the proper * name.familyrder. The parts are recorded in the fhater and mother family names extensions. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Invariants |
|
Examples | spanish name Valero Iglesias spanish Valero Iglesias |
Mappings |
|
Patient.name.family.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.name.family.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.name.family.extension:fathersFamily | |
Definition | The portion of the family name that is derived from the person's father. |
Cardinality | 0...* |
Type | Extension(string) |
Invariants |
|
Examples | spanish name Valero |
Mappings |
|
Patient.name.family.extension:mothersFamily | |
Definition | The portion of the family name that is derived from the person's mother. |
Cardinality | 0...* |
Type | Extension(string) |
Invariants |
|
Examples | spanish name Iglesias |
Mappings |
|
Patient.name.family.value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.String |
Patient.name.given | |
Definition | Given name. |
Cardinality | 0...* |
Type | string |
Summary | True |
Alias | first name, middle name |
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
Invariants |
|
Examples | spanish name Borja |
Mappings |
|
Patient.name.prefix | |
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
Patient.name.suffix | |
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
Patient.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows names to be placed in historical context. |
Invariants |
|
Mappings |
|
Patient.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone). |
Invariants |
|
Mappings |
|
Patient.telecom.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 |
|
Patient.telecom.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 |
|
Patient.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 0...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Invariants |
|
Mappings |
|
Patient.telecom.system.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.telecom.system.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 |
|
Patient.telecom.system.extension:otherContactSystem | |
Definition | Other contact system value which extends the system element in the ContactPoint datatype. |
Cardinality | 0...1 |
Type | Extension(Coding) |
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 |
|
Patient.telecom.system.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Patient.telecom.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
Patient.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Patient.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
Patient.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Patient.gender | |
Definition | Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Must Support | True |
Summary | True |
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. |
Comments | The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. |
Invariants |
|
Mappings |
|
Patient.birthDate | |
Definition | The date of birth for the individual. |
Cardinality | 1...1 |
Type | date |
Must Support | True |
Summary | True |
Requirements | Age of the individual drives many clinical processes. |
Comments | At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). |
Invariants |
|
Mappings |
|
Patient.birthDate.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.birthDate.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 |
|
Patient.birthDate.extension:birthTime | |
Definition | The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively. |
Cardinality | 0...1 |
Type | Extension(dateTime) |
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 |
|
Patient.birthDate.extension:birthTime.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 |
|
Patient.birthDate.extension:birthTime.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.birthDate.extension:birthTime.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 | http://hl7.org/fhir/StructureDefinition/patient-birthTime |
Mappings |
|
Patient.birthDate.extension:birthTime.value[x] | |
Definition | The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively. |
Cardinality | 1...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Patient.birthDate.value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.Date |
Patient.deceased[x] | |
Definition | Indicates if the individual is deceased or not. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. |
Comments | If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. |
Invariants |
|
Mappings |
|
Patient.address | |
Definition | An address for the individual. |
Cardinality | 0...* |
Type | AddressEu |
Must Support | True |
Summary | True |
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
Comments | Patient may have multiple addresses with different uses or applicable periods. |
Invariants |
|
Mappings |
|
Patient.address.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 |
|
Patient.address.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 |
|
Patient.address.extension:addressKey | |
Definition | A patient's address key and type. |
Cardinality | 0...* |
Type | Extension(Complex) |
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 |
|
Patient.address.use | |
Definition | The purpose of this address. |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
Patient.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Summary | True |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | General both |
Mappings |
|
Patient.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Patient.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Patient.address.line.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.address.line.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.address.line.extension:streetName | |
Definition | streetName. |
Cardinality | 0...* |
Type | Extension(string) |
Invariants |
|
Mappings |
|
Patient.address.line.extension:houseNumber | |
Definition | The number of a building, house or lot alongside the street. Also known as "primary street number". This does not number the street but rather the building. |
Cardinality | 0...* |
Type | Extension(string) |
Invariants |
|
Mappings |
|
Patient.address.line.extension:postBox | |
Definition | A numbered box located in a post station. |
Cardinality | 0...* |
Type | Extension(string) |
Invariants |
|
Mappings |
|
Patient.address.line.value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.String |
Patient.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Patient.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Patient.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Invariants |
|
Mappings |
|
Patient.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Patient.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
Patient.address.country.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.address.country.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.address.country.extension:countryCode | |
Definition | Provides a coded expression for the content represented in a string. |
Cardinality | 0...1 |
Type | Extension(Coding) |
Invariants |
|
Mappings |
|
Patient.address.country.extension:countryCode.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 | id |
Mappings |
|
Patient.address.country.extension:countryCode.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.address.country.extension:countryCode.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 | http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding |
Mappings |
|
Patient.address.country.extension:countryCode.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Coding |
Binding | Iso3166-1-2 (preferred) |
Invariants |
|
Mappings |
|
Patient.address.country.value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.String |
Patient.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
Patient.maritalStatus | |
Definition | This field contains a patient's most recent marital (civil) status. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | An indicator to identify the legal marital status of a person |
Requirements | Most, if not all systems capture it. |
Invariants |
|
Mappings |
|
Patient.multipleBirth[x] | |
Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). |
Cardinality | 0...1 |
Type | boolean |
Requirements | For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. |
Comments | Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). |
Invariants |
|
Mappings |
|
Patient.photo | |
Definition | Image of the patient. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. |
Comments | Guidelines:
|
Invariants |
|
Mappings |
|
Patient.contact | |
Definition | A contact party (e.g. guardian, partner, friend) for the patient. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | Need to track people you can contact about the patient. |
Comments | Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact. |
Invariants |
|
Mappings |
|
Patient.contact.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 |
|
Patient.contact.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 |
|
Patient.contact.extension:contactRank | |
Definition | The preferred ranking or order of contact applied to a contact on a patient's contact list. |
Cardinality | 0...1 |
Type | Extension(positiveInt) |
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 |
|
Patient.contact.extension:copyCorrespondenceIndicator | |
Definition | Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence. |
Cardinality | 0...1 |
Type | Extension(boolean) |
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 |
|
Patient.contact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Patient.contact.relationship | |
Definition | The nature of the relationship between the patient and the contact person. |
Cardinality | 0...* |
Type | CodeableConceptIPS |
Binding | The nature of the relationship between a patient and a contact person for that patient. |
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. |
Invariants |
|
Mappings |
|
Patient.contact.name | |
Definition | A name associated with the contact person. |
Cardinality | 0...1 |
Type | HumanName |
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. |
Invariants |
|
Mappings |
|
Patient.contact.telecom | |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Cardinality | 0...* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Invariants |
|
Mappings |
|
Patient.contact.telecom.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 |
|
Patient.contact.telecom.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 |
|
Patient.contact.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 0...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Invariants |
|
Mappings |
|
Patient.contact.telecom.system.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.contact.telecom.system.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 |
|
Patient.contact.telecom.system.extension:otherContactSystem | |
Definition | Other contact system value which extends the system element in the ContactPoint datatype. |
Cardinality | 0...1 |
Type | Extension(Coding) |
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 |
|
Patient.contact.telecom.system.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Patient.contact.telecom.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
Patient.contact.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Patient.contact.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
Patient.contact.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Patient.contact.address | |
Definition | Address for the contact person. |
Cardinality | 0...1 |
Type | AddressEu |
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. |
Invariants |
|
Mappings |
|
Patient.contact.gender | |
Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Requirements | Needed to address the person correctly. |
Invariants |
|
Mappings |
|
Patient.contact.organization | |
Definition | Organization on behalf of which the contact is acting or for which the contact is working. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Requirements | For guardians or business related contacts, the organization is relevant. |
Invariants |
|
Mappings |
|
Patient.contact.period | |
Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
Patient.communication | |
Definition | A language which may be used to communicate with the patient about his or her health. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. |
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
Invariants |
|
Mappings |
|
Patient.communication.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 |
|
Patient.communication.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 |
|
Patient.communication.extension:proficiency | |
Definition | Proficiency level of the communication. |
Cardinality | 0...1 |
Type | Extension(Complex) |
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 |
|
Patient.communication.extension:proficiency.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 |
|
Patient.communication.extension:proficiency.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 |
|
Patient.communication.extension:proficiency.extension:level | |
Definition | How well the patient can communicate this communication (good, poor, etc.). |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Patient.communication.extension:proficiency.extension:level.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 |
|
Patient.communication.extension:proficiency.extension:level.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.communication.extension:proficiency.extension:level.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 | level |
Mappings |
|
Patient.communication.extension:proficiency.extension:level.value[x] | |
Definition | The proficiency level for the communication. |
Cardinality | 1...1 |
Type | Coding |
Binding | The proficiency level for the communication. |
Invariants |
|
Mappings |
|
Patient.communication.extension:proficiency.extension:type | |
Definition | What type of communication for the proficiency (spoken, written, etc.). |
Cardinality | 0...* |
Type | Extension |
Invariants |
|
Patient.communication.extension:proficiency.extension:type.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 |
|
Patient.communication.extension:proficiency.extension:type.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.communication.extension:proficiency.extension:type.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 | type |
Mappings |
|
Patient.communication.extension:proficiency.extension:type.value[x] | |
Definition | The proficiency type for the communication. |
Cardinality | 1...1 |
Type | Coding |
Binding | The proficiency type for the communication. |
Invariants |
|
Mappings |
|
Patient.communication.extension:proficiency.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 | http://hl7.org/fhir/StructureDefinition/patient-proficiency |
Mappings |
|
Patient.communication.extension:proficiency.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list). |
Cardinality | 0...0 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Patient.communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Patient.communication.language | |
Definition | A ValueSet that identifies the language used by a person. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A ValueSet that identifies the language used by a person. |
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Invariants |
|
Mappings |
|
Patient.communication.preferred | |
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
Cardinality | 0...1 |
Type | boolean |
Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. |
Comments | This language is specifically identified for communicating healthcare information. |
Invariants |
|
Mappings |
|
Patient.generalPractitioner | |
Definition | Patient's nominated care provider. |
Cardinality | 0...* |
Type | Reference(Organization | Practitioner | PractitionerRole) |
Alias | careProvider |
Comments | This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. |
Invariants |
|
Mappings |
|
Patient.managingOrganization | |
Definition | Organization that is the custodian of the patient record. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Must Support | True |
Summary | True |
Requirements | Need to know who recognizes this patient record, manages and updates it. |
Comments | There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). |
Invariants |
|
Mappings |
|
Patient.link | |
Definition | Link to another patient resource that concerns the same actual patient. |
Cardinality | 0...* |
Type | BackboneElement |
Modifier | True |
Summary | True |
Requirements | There are multiple use cases:
|
Comments | There is no assumption that linked patient records have mutual links. |
Invariants |
|
Mappings |
|
Patient.link.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 |
|
Patient.link.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. |
Invariants |
|
Mappings |
|
Patient.link.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Patient.link.other | |
Definition | The other patient resource that the link refers to. |
Cardinality | 1...1 |
Type | Reference(Patient | RelatedPerson) |
Summary | True |
Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. |
Invariants |
|
Mappings |
|
Patient.link.type | |
Definition | The type of link between this patient resource and another patient resource. |
Cardinality | 1...1 |
Type | code |
Binding | The type of link between this patient resource and another patient resource. |
Summary | True |
Invariants |
|
Mappings |
|
Table View
Patient | .. | |
Patient.extension | Extension | .. |
Patient.extension.value[x] | .. | |
Patient.extension | Extension | .. |
Patient.extension | Extension | .. |
Patient.extension.value[x] | .. | |
Patient.extension | Extension | .. |
Patient.extension | Extension | .. |
Patient.extension | Extension | ..1 |
Patient.extension | Extension | .. |
Patient.extension | Extension | .. |
Patient.extension | Extension | .. |
Patient.extension.value[x] | .. | |
Patient.extension | Extension | .. |
Patient.identifier | .. | |
Patient.identifier | ..1 | |
Patient.identifier.extension | Extension | ..1 |
Patient.identifier.system | 1.. | |
Patient.identifier.value | 1.. | |
Patient.active | .. | |
Patient.name | .. | |
Patient.telecom | .. | |
Patient.telecom.system | .. | |
Patient.telecom.system.extension | Extension | .. |
Patient.gender | .. | |
Patient.birthDate | .. | |
Patient.birthDate.extension | Extension | .. |
Patient.birthDate.extension.value[x] | .. | |
Patient.address | .. | |
Patient.address.extension | Extension | .. |
Patient.maritalStatus | .. | |
Patient.contact | .. | |
Patient.contact.extension | Extension | .. |
Patient.contact.extension | Extension | .. |
Patient.contact.relationship | .. | |
Patient.contact.telecom | .. | |
Patient.contact.telecom.system | .. | |
Patient.contact.telecom.system.extension | Extension | .. |
Patient.communication | .. | |
Patient.communication.extension | Extension | ..1 |
Patient.communication.extension.extension | .. | |
Patient.communication.extension.extension.value[x] | .. | |
Patient.communication.extension.extension | .. | |
Patient.communication.extension.extension.value[x] | .. | |
Patient.communication.language | .. | |
Patient.managingOrganization | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Patient-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient-Lab" /> <version value="2.6.1" /> <name value="UKCorePatientLab" /> <title value="UK Core Patient Lab" /> <status value="draft" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [Patient](https://hl7.org/fhir/R4/Patient.html)." /> <purpose value="This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="Patient" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-eu-lab" /> <derivation value="constraint" /> <differential> <element id="Patient.extension:birthPlace"> <path value="Patient.extension" /> <sliceName value="birthPlace" /> <short value="The registered place of birth of the patient." /> <definition value="The registered place of birth of the patient." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-birthPlace" /> </type> </element> <element id="Patient.extension:birthPlace.value[x]"> <path value="Patient.extension.value[x]" /> <short value="The registered place of birth of the patient." /> </element> <element id="Patient.extension:birthSex"> <path value="Patient.extension" /> <sliceName value="birthSex" /> <short value="The patient's phenotypic sex at birth." /> <definition value="The patient's phenotypic sex at birth." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" /> </type> </element> <element id="Patient.extension:cadavericDonor"> <path value="Patient.extension" /> <sliceName value="cadavericDonor" /> <short value="Post-mortem donor status." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" /> </type> </element> <element id="Patient.extension:cadavericDonor.value[x]"> <path value="Patient.extension.value[x]" /> <short value="Post-mortem donor status." /> <definition value="Flag indicating whether the patient authorized the donation of body parts after death." /> </element> <element id="Patient.extension:contactPreference"> <path value="Patient.extension" /> <sliceName value="contactPreference" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" /> </type> </element> <element id="Patient.extension:deathNotificationStatus"> <path value="Patient.extension" /> <sliceName value="deathNotificationStatus" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" /> </type> </element> <element id="Patient.extension:ethnicCategory"> <path value="Patient.extension" /> <sliceName value="ethnicCategory" /> <short value="The ethnicity of the subject." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory" /> </type> </element> <element id="Patient.extension:fetalStatus"> <path value="Patient.extension" /> <sliceName value="fetalStatus" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus" /> </type> <isModifier value="false" /> </element> <element id="Patient.extension:residentialStatus"> <path value="Patient.extension" /> <sliceName value="residentialStatus" /> <short value="The residential status of the patient." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" /> </type> </element> <element id="Patient.extension:patientInterpreterRequired"> <path value="Patient.extension" /> <sliceName value="patientInterpreterRequired" /> <short value="Indicator showing whether the patient needs an interpreter." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" /> </type> </element> <element id="Patient.extension:patientInterpreterRequired.value[x]"> <path value="Patient.extension.value[x]" /> <short value="Indicator showing whether the patient needs an interpreter" /> <definition value="Indicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner." /> </element> <element id="Patient.extension:nhsNumberUnavailableReason"> <path value="Patient.extension" /> <sliceName value="nhsNumberUnavailableReason" /> <short value="Reason why this Patient does not include an NHS Number identifier." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason" /> </type> <isModifier value="false" /> </element> <element id="Patient.identifier"> <path value="Patient.identifier" /> <slicing> <discriminator> <type value="value" /> <path value="system" /> </discriminator> <ordered value="false" /> <rules value="open" /> </slicing> <short value="An identifier for this patient." /> <mustSupport value="true" /> </element> <element id="Patient.identifier:nhsNumber"> <path value="Patient.identifier" /> <sliceName value="nhsNumber" /> <short value="The patient's NHS number." /> <max value="1" /> <mustSupport value="false" /> </element> <element id="Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus"> <path value="Patient.identifier.extension" /> <sliceName value="nhsNumberVerificationStatus" /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" /> </type> <mustSupport value="false" /> </element> <element id="Patient.identifier:nhsNumber.system"> <path value="Patient.identifier.system" /> <min value="1" /> <fixedUri value="https://fhir.nhs.uk/Id/nhs-number" /> </element> <element id="Patient.identifier:nhsNumber.value"> <path value="Patient.identifier.value" /> <min value="1" /> </element> <element id="Patient.active"> <path value="Patient.active" /> <short value="Whether this patient's record is in active use." /> <mustSupport value="true" /> </element> <element id="Patient.name"> <path value="Patient.name" /> <short value="A name associated with the patient." /> <mustSupport value="true" /> </element> <element id="Patient.telecom"> <path value="Patient.telecom" /> <short value="A contact detail for the individual." /> <mustSupport value="true" /> </element> <element id="Patient.telecom.system.extension:otherContactSystem"> <path value="Patient.telecom.system.extension" /> <sliceName value="otherContactSystem" /> <short value="Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" /> </type> </element> <element id="Patient.gender"> <path value="Patient.gender" /> <short value="The gender that the patient is considered to have for administration and record keeping purposes." /> <mustSupport value="true" /> </element> <element id="Patient.birthDate"> <path value="Patient.birthDate" /> <short value="The date of birth for the individual." /> <mustSupport value="true" /> </element> <element id="Patient.birthDate.extension:birthTime"> <path value="Patient.birthDate.extension" /> <sliceName value="birthTime" /> <short value="The time of day that the patient was born. This SHOULD be included when the birth time is relevant." /> <definition value="The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-birthTime" /> </type> </element> <element id="Patient.birthDate.extension:birthTime.value[x]"> <path value="Patient.birthDate.extension.value[x]" /> <short value="Time of day of birth." /> <definition value="The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively." /> </element> <element id="Patient.address"> <path value="Patient.address" /> <mustSupport value="true" /> </element> <element id="Patient.address.extension:addressKey"> <path value="Patient.address.extension" /> <sliceName value="addressKey" /> <short value="A patient's address key and type" /> <definition value="A patient's address key and type." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" /> </type> <mustSupport value="false" /> </element> <element id="Patient.maritalStatus"> <path value="Patient.maritalStatus" /> <binding> <strength value="extensible" /> <description value="An indicator to identify the legal marital status of a person" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode" /> </binding> </element> <element id="Patient.contact.extension:contactRank"> <path value="Patient.contact.extension" /> <sliceName value="contactRank" /> <short value="The preferred ranking or order of contact applied to a contact on a Patient's contact list." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" /> </type> </element> <element id="Patient.contact.extension:copyCorrespondenceIndicator"> <path value="Patient.contact.extension" /> <sliceName value="copyCorrespondenceIndicator" /> <short value="Indicates that a must be copied in to all related correspondence." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" /> </type> </element> <element id="Patient.contact.relationship"> <path value="Patient.contact.relationship" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" /> </binding> </element> <element id="Patient.contact.telecom.system.extension:otherContactSystem"> <path value="Patient.contact.telecom.system.extension" /> <sliceName value="otherContactSystem" /> <short value="Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" /> </type> </element> <element id="Patient.communication.extension:proficiency"> <path value="Patient.communication.extension" /> <sliceName value="proficiency" /> <short value="The patient's proficiency level of the communication method." /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-proficiency" /> </type> </element> <element id="Patient.communication.extension:proficiency.extension:level"> <path value="Patient.communication.extension.extension" /> <sliceName value="level" /> </element> <element id="Patient.communication.extension:proficiency.extension:level.value[x]"> <path value="Patient.communication.extension.extension.value[x]" /> <short value="The proficiency level for the communication" /> <definition value="The proficiency level for the communication." /> </element> <element id="Patient.communication.extension:proficiency.extension:type"> <path value="Patient.communication.extension.extension" /> <sliceName value="type" /> </element> <element id="Patient.communication.extension:proficiency.extension:type.value[x]"> <path value="Patient.communication.extension.extension.value[x]" /> <short value="The proficiency type for the communication" /> <definition value="The proficiency type for the communication." /> </element> <element id="Patient.communication.language"> <path value="Patient.communication.language" /> <short value="A ValueSet that identifies the language used by a person." /> <definition value="A ValueSet that identifies the language used by a person." /> <binding> <strength value="required" /> <description value="A ValueSet that identifies the language used by a person." /> <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" /> </binding> </element> <element id="Patient.managingOrganization"> <path value="Patient.managingOrganization" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Patient-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient-Lab", "version": "2.6.1", "name": "UKCorePatientLab", "title": "UK Core Patient Lab", "status": "draft", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Patient](https://hl7.org/fhir/R4/Patient.html).", "purpose": "This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services.", "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", "kind": "resource", "abstract": false, "type": "Patient", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/Patient-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "Patient.extension:birthPlace", "path": "Patient.extension", "sliceName": "birthPlace", "short": "The registered place of birth of the patient.", "definition": "The registered place of birth of the patient.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" ] } ] }, { "id": "Patient.extension:birthPlace.value[x]", "path": "Patient.extension.value[x]", "short": "The registered place of birth of the patient." }, { "id": "Patient.extension:birthSex", "path": "Patient.extension", "sliceName": "birthSex", "short": "The patient's phenotypic sex at birth.", "definition": "The patient's phenotypic sex at birth.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex" ] } ] }, { "id": "Patient.extension:cadavericDonor", "path": "Patient.extension", "sliceName": "cadavericDonor", "short": "Post-mortem donor status.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor" ] } ] }, { "id": "Patient.extension:cadavericDonor.value[x]", "path": "Patient.extension.value[x]", "short": "Post-mortem donor status.", "definition": "Flag indicating whether the patient authorized the donation of body parts after death." }, { "id": "Patient.extension:contactPreference", "path": "Patient.extension", "sliceName": "contactPreference", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference" ] } ] }, { "id": "Patient.extension:deathNotificationStatus", "path": "Patient.extension", "sliceName": "deathNotificationStatus", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus" ] } ] }, { "id": "Patient.extension:ethnicCategory", "path": "Patient.extension", "sliceName": "ethnicCategory", "short": "The ethnicity of the subject.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory" ] } ] }, { "id": "Patient.extension:fetalStatus", "path": "Patient.extension", "sliceName": "fetalStatus", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus" ] } ], "isModifier": false }, { "id": "Patient.extension:residentialStatus", "path": "Patient.extension", "sliceName": "residentialStatus", "short": "The residential status of the patient.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus" ] } ] }, { "id": "Patient.extension:patientInterpreterRequired", "path": "Patient.extension", "sliceName": "patientInterpreterRequired", "short": "Indicator showing whether the patient needs an interpreter.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" ] } ] }, { "id": "Patient.extension:patientInterpreterRequired.value[x]", "path": "Patient.extension.value[x]", "short": "Indicator showing whether the patient needs an interpreter", "definition": "Indicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner." }, { "id": "Patient.extension:nhsNumberUnavailableReason", "path": "Patient.extension", "sliceName": "nhsNumberUnavailableReason", "short": "Reason why this Patient does not include an NHS Number identifier.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason" ] } ], "isModifier": false }, { "id": "Patient.identifier", "path": "Patient.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "ordered": false, "rules": "open" }, "short": "An identifier for this patient.", "mustSupport": true }, { "id": "Patient.identifier:nhsNumber", "path": "Patient.identifier", "sliceName": "nhsNumber", "short": "The patient's NHS number.", "max": "1", "mustSupport": false }, { "id": "Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus", "path": "Patient.identifier.extension", "sliceName": "nhsNumberVerificationStatus", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus" ] } ], "mustSupport": false }, { "id": "Patient.identifier:nhsNumber.system", "path": "Patient.identifier.system", "min": 1, "fixedUri": "https://fhir.nhs.uk/Id/nhs-number" }, { "id": "Patient.identifier:nhsNumber.value", "path": "Patient.identifier.value", "min": 1 }, { "id": "Patient.active", "path": "Patient.active", "short": "Whether this patient's record is in active use.", "mustSupport": true }, { "id": "Patient.name", "path": "Patient.name", "short": "A name associated with the patient.", "mustSupport": true }, { "id": "Patient.telecom", "path": "Patient.telecom", "short": "A contact detail for the individual.", "mustSupport": true }, { "id": "Patient.telecom.system.extension:otherContactSystem", "path": "Patient.telecom.system.extension", "sliceName": "otherContactSystem", "short": "Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" ] } ] }, { "id": "Patient.gender", "path": "Patient.gender", "short": "The gender that the patient is considered to have for administration and record keeping purposes.", "mustSupport": true }, { "id": "Patient.birthDate", "path": "Patient.birthDate", "short": "The date of birth for the individual.", "mustSupport": true }, { "id": "Patient.birthDate.extension:birthTime", "path": "Patient.birthDate.extension", "sliceName": "birthTime", "short": "The time of day that the patient was born. This SHOULD be included when the birth time is relevant.", "definition": "The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-birthTime" ] } ] }, { "id": "Patient.birthDate.extension:birthTime.value[x]", "path": "Patient.birthDate.extension.value[x]", "short": "Time of day of birth.", "definition": "The time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively." }, { "id": "Patient.address", "path": "Patient.address", "mustSupport": true }, { "id": "Patient.address.extension:addressKey", "path": "Patient.address.extension", "sliceName": "addressKey", "short": "A patient's address key and type", "definition": "A patient's address key and type.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" ] } ], "mustSupport": false }, { "id": "Patient.maritalStatus", "path": "Patient.maritalStatus", "binding": { "strength": "extensible", "description": "An indicator to identify the legal marital status of a person", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode" } }, { "id": "Patient.contact.extension:contactRank", "path": "Patient.contact.extension", "sliceName": "contactRank", "short": "The preferred ranking or order of contact applied to a contact on a Patient's contact list.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" ] } ] }, { "id": "Patient.contact.extension:copyCorrespondenceIndicator", "path": "Patient.contact.extension", "sliceName": "copyCorrespondenceIndicator", "short": "Indicates that a must be copied in to all related correspondence.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator" ] } ] }, { "id": "Patient.contact.relationship", "path": "Patient.contact.relationship", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType" } }, { "id": "Patient.contact.telecom.system.extension:otherContactSystem", "path": "Patient.contact.telecom.system.extension", "sliceName": "otherContactSystem", "short": "Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem" ] } ] }, { "id": "Patient.communication.extension:proficiency", "path": "Patient.communication.extension", "sliceName": "proficiency", "short": "The patient's proficiency level of the communication method.", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-proficiency" ] } ] }, { "id": "Patient.communication.extension:proficiency.extension:level", "path": "Patient.communication.extension.extension", "sliceName": "level" }, { "id": "Patient.communication.extension:proficiency.extension:level.value[x]", "path": "Patient.communication.extension.extension.value[x]", "short": "The proficiency level for the communication", "definition": "The proficiency level for the communication." }, { "id": "Patient.communication.extension:proficiency.extension:type", "path": "Patient.communication.extension.extension", "sliceName": "type" }, { "id": "Patient.communication.extension:proficiency.extension:type.value[x]", "path": "Patient.communication.extension.extension.value[x]", "short": "The proficiency type for the communication", "definition": "The proficiency type for the communication." }, { "id": "Patient.communication.language", "path": "Patient.communication.language", "short": "A ValueSet that identifies the language used by a person.", "definition": "A ValueSet that identifies the language used by a person.", "binding": { "strength": "required", "description": "A ValueSet that identifies the language used by a person.", "valueSet": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "id": "Patient.managingOrganization", "path": "Patient.managingOrganization", "mustSupport": true } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner-Lab | draft | 2.4.0 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource Practitioner. |
Profile_Purpose |
---|
This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals. |
Detailed Descriptions
Practitioner | |
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Practitioner.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Practitioner.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Practitioner.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Practitioner.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Practitioner.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Practitioner.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Practitioner.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Invariants |
|
Mappings |
|
Practitioner.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Practitioner.identifier | |
Definition | An identifier that applies to this person in this role. |
Cardinality | 0...* |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | Often, specific identities are assigned for the agent. |
Invariants |
|
Mappings |
|
Practitioner.active | |
Definition | Whether this practitioner's record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. |
Comments | If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. |
Invariants |
|
Mappings |
|
Practitioner.name | |
Definition | The name(s) associated with the practitioner. |
Cardinality | 1...* |
Type | HumanName |
Must Support | True |
Summary | True |
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. |
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
|
Invariants |
|
Mappings |
|
Practitioner.name.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 |
|
Practitioner.name.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 |
|
Practitioner.name.use | |
Definition | Identifies the purpose for this name. |
Cardinality | 0...1 |
Type | code |
Binding | The use of a human name. |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
Practitioner.name.text | |
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Mappings |
|
Practitioner.name.family | |
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Alias | surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Invariants |
|
Mappings |
|
Practitioner.name.given | |
Definition | Given name. |
Cardinality | 0...* |
Type | string |
Must Support | True |
Summary | True |
Alias | first name, middle name |
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
Invariants |
|
Mappings |
|
Practitioner.name.prefix | |
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
Practitioner.name.suffix | |
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
Practitioner.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows names to be placed in historical context. |
Invariants |
|
Mappings |
|
Practitioner.telecom | |
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. |
Invariants |
|
Mappings |
|
Practitioner.address | |
Definition | Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. |
Cardinality | 0...* |
Type | Address |
Must Support | True |
Summary | True |
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. |
Comments | The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). |
Invariants |
|
Mappings |
|
Practitioner.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Summary | True |
Requirements | Needed to address the person correctly. |
Invariants |
|
Mappings |
|
Practitioner.birthDate | |
Definition | The date of birth for the practitioner. |
Cardinality | 0...1 |
Type | date |
Summary | True |
Requirements | Needed for identification. |
Invariants |
|
Mappings |
|
Practitioner.photo | |
Definition | Image of the person. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
Invariants |
|
Mappings |
|
Practitioner.qualification | |
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Practitioner.qualification.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 |
|
Practitioner.qualification.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. |
Invariants |
|
Mappings |
|
Practitioner.qualification.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Practitioner.qualification.identifier | |
Definition | An identifier that applies to this person's qualification in this role. |
Cardinality | 0...* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the qualification. |
Invariants |
|
Mappings |
|
Practitioner.qualification.code | |
Definition | Coded representation of the qualification. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Specific qualification the practitioner has to provide a service. |
Invariants |
|
Mappings |
|
Practitioner.qualification.period | |
Definition | Period during which the qualification is valid. |
Cardinality | 0...1 |
Type | Period |
Requirements | Qualifications are often for a limited period of time, and can be revoked. |
Invariants |
|
Mappings |
|
Practitioner.qualification.issuer | |
Definition | Organization that regulates and issues the qualification. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Invariants |
|
Mappings |
|
Practitioner.communication | |
Definition | A language the practitioner can use in patient communication. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A ValueSet that identifies the language used by a person. |
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Invariants |
|
Mappings |
|
Table View
Practitioner | .. | |
Practitioner.identifier | .. | |
Practitioner.name | .. | |
Practitioner.telecom | .. | |
Practitioner.communication | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Practitioner-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner-Lab" /> <version value="2.4.0" /> <name value="UKCorePractitionerLab" /> <title value="UK Core Practitioner Lab" /> <status value="draft" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html)." /> <purpose value="This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="Practitioner" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/Practitioner-eu-lab" /> <derivation value="constraint" /> <differential> <element id="Practitioner.identifier"> <path value="Practitioner.identifier" /> <short value="An identifier that applies to this person in this role." /> <mustSupport value="true" /> </element> <element id="Practitioner.name"> <path value="Practitioner.name" /> <short value="The name(s) associated with the practitioner." /> <mustSupport value="true" /> </element> <element id="Practitioner.telecom"> <path value="Practitioner.telecom" /> <short value="A contact detail for the practitioner (that apply to all roles)." /> <mustSupport value="true" /> </element> <element id="Practitioner.communication"> <path value="Practitioner.communication" /> <binding> <strength value="required" /> <description value="A ValueSet that identifies the language used by a person." /> <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Practitioner-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Practitioner-Lab", "version": "2.4.0", "name": "UKCorePractitionerLab", "title": "UK Core Practitioner Lab", "status": "draft", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Practitioner](https://hl7.org/fhir/R4/Practitioner.html).", "purpose": "This profile allows exchange of information about all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities, is used for attribution of activities and responsibilities to these individuals.", "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", "kind": "resource", "abstract": false, "type": "Practitioner", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/Practitioner-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "Practitioner.identifier", "path": "Practitioner.identifier", "short": "An identifier that applies to this person in this role.", "mustSupport": true }, { "id": "Practitioner.name", "path": "Practitioner.name", "short": "The name(s) associated with the practitioner.", "mustSupport": true }, { "id": "Practitioner.telecom", "path": "Practitioner.telecom", "short": "A contact detail for the practitioner (that apply to all roles).", "mustSupport": true }, { "id": "Practitioner.communication", "path": "Practitioner.communication", "binding": { "strength": "required", "description": "A ValueSet that identifies the language used by a person.", "valueSet": "http://hl7.org/fhir/ValueSet/all-languages" } } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole-IPS | draft | 2.4.0 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource PractitionerRole. |
Profile_Purpose |
---|
This profile allows exchange of a specific set of roles, specialties and services that a practitioner may perform at an organisation for a period of time. |
Detailed Descriptions
PractitionerRole | |
Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
PractitionerRole.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
PractitionerRole.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
PractitionerRole.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
PractitionerRole.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
PractitionerRole.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
PractitionerRole.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
PractitionerRole.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. |
Invariants |
|
Mappings |
|
PractitionerRole.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
PractitionerRole.identifier | |
Definition | Business Identifiers that are specific to a role/location. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Often, specific identities are assigned for the agent. |
Invariants |
|
Mappings |
|
PractitionerRole.active | |
Definition | Whether this practitioner role record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Summary | True |
Requirements | Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. |
Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. |
Invariants |
|
Mappings |
|
PractitionerRole.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Cardinality | 0...1 |
Type | Period |
Must Support | True |
Summary | True |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Invariants |
|
Mappings |
|
PractitionerRole.practitioner | |
Definition | Practitioner that is able to provide the defined services for the organization. |
Cardinality | 0...1 |
Type | Reference(PractitionerUvIps) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
PractitionerRole.organization | |
Definition | The organization where the Practitioner performs the roles associated. |
Cardinality | 0...1 |
Type | Reference(OrganizationUvIps) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
PractitionerRole.code | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Cardinality | 0...* |
Type | CodeableConceptIPS |
Binding | Healthcare professional role codes from International Standard Classification of Occupations (ISCO). |
Requirements | Need to know what authority the practitioner has - what can they do? |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
PractitionerRole.specialty | |
Definition | Specific specialty of the practitioner. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Specific specialty associated with the agency. |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
PractitionerRole.location | |
Definition | The location(s) at which this practitioner provides care. |
Cardinality | 0...* |
Type | Reference(Location) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
PractitionerRole.healthcareService | |
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). |
Cardinality | 0...* |
Type | Reference(HealthcareService) |
Invariants |
|
Mappings |
|
PractitionerRole.telecom | |
Definition | Contact details that are specific to the role/location/service. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime | |
Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. |
Cardinality | 0...* |
Type | BackboneElement |
Comments | More detailed availability information may be provided in associated Schedule/Slot resources. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.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 |
|
PractitionerRole.availableTime.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. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
PractitionerRole.availableTime.daysOfWeek | |
Definition | Indicates which days of the week are available between the start and end Times. |
Cardinality | 0...* |
Type | code |
Binding | The days of the week. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.allDay | |
Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.availableStartTime | |
Definition | The opening time of day. Note: If the AllDay flag is set, then this time is ignored. |
Cardinality | 0...1 |
Type | time |
Comments | The timezone is expected to be for where this HealthcareService is provided at. |
Invariants |
|
Mappings |
|
PractitionerRole.availableTime.availableEndTime | |
Definition | The closing time of day. Note: If the AllDay flag is set, then this time is ignored. |
Cardinality | 0...1 |
Type | time |
Comments | The timezone is expected to be for where this HealthcareService is provided at. |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable | |
Definition | The practitioner is not available or performing this role during this period of time due to the provided reason. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.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 |
|
PractitionerRole.notAvailable.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. |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
PractitionerRole.notAvailable.description | |
Definition | The reason that can be presented to the user as to why this time is not available. |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
PractitionerRole.notAvailable.during | |
Definition | Service is not available (seasonally or for a public holiday) from this date. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
PractitionerRole.availabilityExceptions | |
Definition | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
PractitionerRole.endpoint | |
Definition | Technical endpoints providing access to services operated for the practitioner with this role. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Requirements | Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. |
Invariants |
|
Mappings |
|
Table View
PractitionerRole | .. | |
PractitionerRole.active | .. | |
PractitionerRole.period | .. | |
PractitionerRole.practitioner | .. | |
PractitionerRole.organization | .. | |
PractitionerRole.specialty | .. | |
PractitionerRole.location | .. | |
PractitionerRole.telecom | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-PractitionerRole-IPS" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole-IPS" /> <version value="2.4.0" /> <name value="UKCorePractitionerRoleIPS" /> <title value="UK Core Practitioner Role IPS" /> <status value="draft" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [PractitionerRole](https://hl7.org/fhir/R4/PractitionerRole.html)." /> <purpose value="This profile allows exchange of a specific set of roles, specialties and services that a practitioner may perform at an organisation for a period of time." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="PractitionerRole" /> <baseDefinition value="http://hl7.org/fhir/uv/ips/StructureDefinition/PractitionerRole-uv-ips" /> <derivation value="constraint" /> <differential> <element id="PractitionerRole.active"> <path value="PractitionerRole.active" /> <short value="Whether this practitioner role record is in active use." /> <mustSupport value="true" /> </element> <element id="PractitionerRole.period"> <path value="PractitionerRole.period" /> <short value="The period during which the practitioner is authorized to perform in these role(s)." /> <mustSupport value="true" /> </element> <element id="PractitionerRole.practitioner"> <path value="PractitionerRole.practitioner" /> <short value="Practitioner that is able to provide the defined services for the organization." /> <mustSupport value="true" /> </element> <element id="PractitionerRole.organization"> <path value="PractitionerRole.organization" /> <short value="Organization where the roles are available." /> <mustSupport value="true" /> </element> <element id="PractitionerRole.specialty"> <path value="PractitionerRole.specialty" /> <short value="Specific specialty of the practitioner." /> <mustSupport value="true" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" /> </binding> </element> <element id="PractitionerRole.location"> <path value="PractitionerRole.location" /> <short value="The location(s) at which this practitioner provides care." /> <mustSupport value="true" /> </element> <element id="PractitionerRole.telecom"> <path value="PractitionerRole.telecom" /> <short value="Contact details that are specific to the role/location/service." /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-PractitionerRole-IPS", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole-IPS", "version": "2.4.0", "name": "UKCorePractitionerRoleIPS", "title": "UK Core Practitioner Role IPS", "status": "draft", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [PractitionerRole](https://hl7.org/fhir/R4/PractitionerRole.html).", "purpose": "This profile allows exchange of a specific set of roles, specialties and services that a practitioner may perform at an organisation for a period of time.", "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", "kind": "resource", "abstract": false, "type": "PractitionerRole", "baseDefinition": "http://hl7.org/fhir/uv/ips/StructureDefinition/PractitionerRole-uv-ips", "derivation": "constraint", "differential": { "element": [ { "id": "PractitionerRole.active", "path": "PractitionerRole.active", "short": "Whether this practitioner role record is in active use.", "mustSupport": true }, { "id": "PractitionerRole.period", "path": "PractitionerRole.period", "short": "The period during which the practitioner is authorized to perform in these role(s).", "mustSupport": true }, { "id": "PractitionerRole.practitioner", "path": "PractitionerRole.practitioner", "short": "Practitioner that is able to provide the defined services for the organization.", "mustSupport": true }, { "id": "PractitionerRole.organization", "path": "PractitionerRole.organization", "short": "Organization where the roles are available.", "mustSupport": true }, { "id": "PractitionerRole.specialty", "path": "PractitionerRole.specialty", "short": "Specific specialty of the practitioner.", "mustSupport": true, "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode" } }, { "id": "PractitionerRole.location", "path": "PractitionerRole.location", "short": "The location(s) at which this practitioner provides care.", "mustSupport": true }, { "id": "PractitionerRole.telecom", "path": "PractitionerRole.telecom", "short": "Contact details that are specific to the role/location/service.", "mustSupport": true } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest-Lab | active | 2.0.0 | 2025-05-13 | This profile defines the specific UK constraints and extensions on the International FHIR resource ServiceRequest, in order to support requesting laboratory services. |
Profile_Purpose |
---|
To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report. |
Detailed Descriptions
ServiceRequest | |
Definition | Laboratory Order composition. |
Cardinality | 0...* |
Alias | diagnostic request, referral, referral request, transfer of care request |
Invariants |
|
Mappings |
|
ServiceRequest.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ServiceRequest.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
ServiceRequest.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
ServiceRequest.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
ServiceRequest.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
ServiceRequest.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
ServiceRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 |
|
ServiceRequest.extension:sourceOfServiceRequest | |
Definition | This represents the source of referral. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
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 |
|
ServiceRequest.extension:additionalContact | |
Definition | Details of an additional contact, who should be contacted regarding questions arising from the service request. |
Cardinality | 0...* |
Type | Extension(Reference(UKCoreOrganization | UKCorePractitioner | UKCorePractitionerRole)) |
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 |
|
ServiceRequest.extension:coverage | |
Definition | The funding category for the Service Request. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
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 |
|
ServiceRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
ServiceRequest.identifier | |
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
Cardinality | 1...* |
Type | Identifier |
Summary | True |
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below. |
Invariants |
|
Mappings |
|
ServiceRequest.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
Cardinality | 0...* |
Type | canonical(ActivityDefinition | PlanDefinition) |
Summary | True |
Comments | Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
ServiceRequest.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
Cardinality | 0...* |
Type | uri |
Summary | True |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Invariants |
|
Mappings |
|
ServiceRequest.basedOn | |
Definition | Plan/proposal/order fulfilled by this request. |
Cardinality | 0...* |
Type | Reference(CarePlan | ServiceRequest | MedicationRequest) |
Summary | True |
Alias | fulfills |
Invariants |
|
Mappings |
|
ServiceRequest.replaces | |
Definition | The request takes the place of the referenced completed or terminated request(s). |
Cardinality | 0...* |
Type | Reference(ServiceRequest) |
Summary | True |
Alias | supersedes, prior, renewed order |
Invariants |
|
Mappings |
|
ServiceRequest.requisition | |
Definition | A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Alias | grouperId, groupIdentifier |
Requirements | Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. |
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
Invariants |
|
Mappings |
|
ServiceRequest.status | |
Definition | The status of the order. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a service order. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. |
Invariants |
|
Mappings |
|
ServiceRequest.intent | |
Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
Cardinality | 1...1 |
Type | code |
Binding | The kind of service request. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
Invariants |
|
Mappings |
|
ServiceRequest.category | |
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Classification of the requested service. |
Summary | True |
Requirements | Used for filtering what service request are retrieved and displayed. |
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
Slicing | Unordered, Open, by coding.system(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing | |
Definition | A code that classifies the service for Genomics, whether it is a Whole Case Genome Sequencing or non-Whole Genome Sequencing for cancer or rare diseases |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Classification of the requested service. |
Summary | True |
Requirements | Used for filtering what service request are retrieved and displayed. |
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.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 |
|
ServiceRequest.category:genomicsWholeCaseSequencing.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 |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.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 |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.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 |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory |
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
ServiceRequest.category:genomicsWholeCaseSequencing.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
ServiceRequest.priority | |
Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the level of importance to be assigned to actioning the request. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.priority.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
ServiceRequest.priority.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 |
|
ServiceRequest.priority.extension:priorityReason | |
Definition | A SNOMED CT concept representing the reason a Service Request is urgent |
Cardinality | 0...* |
Type | Extension(CodeableConcept) |
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 |
|
ServiceRequest.priority.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
ServiceRequest.doNotPerform | |
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. |
Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. |
Invariants |
|
Mappings |
|
ServiceRequest.code | |
Definition | A set of codes from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test requests. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A set of codes that define laboratory medicine test requests. Selected from the SNOMED CT UK coding system. |
Summary | True |
Alias | service requested |
Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. |
Invariants |
|
Mappings |
|
ServiceRequest.orderDetail | |
Definition | Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codified order entry details which are based on order context. |
Summary | True |
Alias | detailed instructions |
Comments | For information from the medical record intended to support the delivery of the requested services, use the |
Invariants |
|
Mappings |
|
ServiceRequest.quantity[x] | |
Definition | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | When ordering a service the number of service items may need to be specified separately from the the service item. |
Invariants |
|
Mappings |
|
ServiceRequest.subject | |
Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
Cardinality | 1...1 |
Type | Reference(PatientEuLab | PatientAnimalEu | Group | Location | Device) |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.encounter | |
Definition | An encounter that provides additional information about the healthcare context in which this request is made. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Alias | context |
Invariants |
|
Mappings |
|
ServiceRequest.occurrence[x] | |
Definition | The date/time at which the requested service should occur. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | schedule |
Invariants |
|
Mappings |
|
ServiceRequest.asNeeded[x] | |
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. |
Cardinality | 0...1 |
Type | boolean |
Binding | A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.authoredOn | |
Definition | When the request transitioned to being actionable. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | orderedOn |
Invariants |
|
Mappings |
|
ServiceRequest.requester | |
Definition | The individual who initiated the request and has responsibility for its activation. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) |
Must Support | True |
Summary | True |
Alias | author, orderer |
Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. |
Invariants |
|
Mappings |
|
ServiceRequest.performerType | |
Definition | Desired type of performer for doing the requested service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
Summary | True |
Alias | specialty |
Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. |
Invariants |
|
Mappings |
|
ServiceRequest.performer | |
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
Summary | True |
Alias | request recipient |
Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). |
Invariants |
|
Mappings |
|
ServiceRequest.locationCode | |
Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A location type where services are delivered. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.locationReference | |
Definition | A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
Cardinality | 0...* |
Type | Reference(Location) |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.reasonCode | |
Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A set of codes that define a reason for a service request. |
Summary | True |
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use |
Invariants |
|
Mappings |
|
ServiceRequest.reasonReference | |
Definition | Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
Cardinality | 0...* |
Type | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
Summary | True |
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in |
Invariants |
|
Mappings |
|
ServiceRequest.insurance | |
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
Cardinality | 0...* |
Type | Reference(Coverage) |
Invariants |
|
Mappings |
|
ServiceRequest.supportingInfo | |
Definition | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
Cardinality | 0...* |
Type | Reference(Resource) |
Alias | Ask at order entry question, AOE |
Comments | To represent information about how the services are to be delivered use the |
Invariants |
|
Mappings |
|
ServiceRequest.specimen | |
Definition | One or more specimens that the laboratory procedure will use. |
Cardinality | 0...* |
Type | Reference(SpecimenEu) |
Summary | True |
Comments | If the specimen information are known when the order is created then the ServiceRequest.specimen should be used. If the ServiceRequest can be updated when the specimen is collected then the ServiceRequest.specimen or the Specimen.request could be used. Otherwise the relationship is recorded in the Specimen.request element |
Invariants |
|
Mappings |
|
ServiceRequest.bodySite | |
Definition | Anatomic location where the procedure should be performed. This is the target site. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Summary | True |
Alias | location |
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. |
Comments | Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure. |
Invariants |
|
Mappings |
|
ServiceRequest.note | |
Definition | Any other notes and comments made about the service request. For example, internal billing notes. |
Cardinality | 0...* |
Type | Annotation |
Invariants |
|
Mappings |
|
ServiceRequest.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.relevantHistory | |
Definition | Key events in the history of the request. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
Invariants |
|
Mappings |
|
Table View
ServiceRequest | .. | |
ServiceRequest.extension | Extension | ..1 |
ServiceRequest.extension | Extension | .. |
ServiceRequest.extension | Extension | ..1 |
ServiceRequest.status | .. | |
ServiceRequest.intent | .. | |
ServiceRequest.category | .. | |
ServiceRequest.category | .. | |
ServiceRequest.category.coding | .. | |
ServiceRequest.category.coding.system | .. | |
ServiceRequest.priority | .. | |
ServiceRequest.priority.extension | Extension | .. |
ServiceRequest.code | .. | |
ServiceRequest.orderDetail | .. | |
ServiceRequest.subject | .. | |
ServiceRequest.requester | .. | |
ServiceRequest.reasonCode | .. | |
ServiceRequest.bodySite | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-ServiceRequest-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest-Lab" /> <version value="2.0.0" /> <name value="UKCoreServiceRequestLab" /> <title value="UK Core Service Request Lab" /> <status value="active" /> <date value="2025-05-13" /> <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="This profile defines the specific UK constraints and extensions on the International FHIR resource [ServiceRequest](https://hl7.org/fhir/R4/ServiceRequest.html), in order to support requesting laboratory services." /> <purpose value="To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="ServiceRequest" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/ServiceRequest-eu-lab" /> <derivation value="constraint" /> <differential> <element id="ServiceRequest.extension:sourceOfServiceRequest"> <path value="ServiceRequest.extension" /> <sliceName value="sourceOfServiceRequest" /> <short value="Describes the source of the Service Request." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.extension:additionalContact"> <path value="ServiceRequest.extension" /> <sliceName value="additionalContact" /> <short value="Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.extension:coverage"> <path value="ServiceRequest.extension" /> <sliceName value="coverage" /> <short value="Supports the exchange of information describing the method of funding for the Service Request." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.status"> <path value="ServiceRequest.status" /> <short value="The status of the order." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.intent"> <path value="ServiceRequest.intent" /> <short value="Whether the request is a proposal, plan, an original order or a reflex order." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.category"> <path value="ServiceRequest.category" /> <slicing> <discriminator> <type value="value" /> <path value="coding.system" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="ServiceRequest.category:genomicsWholeCaseSequencing"> <path value="ServiceRequest.category" /> <sliceName value="genomicsWholeCaseSequencing" /> <short value="Classification of Genomics service" /> <definition value="A code that classifies the service for Genomics, whether it is a Whole Case Genome Sequencing or non-Whole Genome Sequencing for cancer or rare diseases" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory" /> </binding> </element> <element id="ServiceRequest.category:genomicsWholeCaseSequencing.coding.system"> <path value="ServiceRequest.category.coding.system" /> <fixedUri value="https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory" /> </element> <element id="ServiceRequest.priority.extension:priorityReason"> <path value="ServiceRequest.priority.extension" /> <sliceName value="priorityReason" /> <short value="Supports the underlying reason why a Service Request is urgent." /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason" /> </type> <isModifier value="false" /> </element> <element id="ServiceRequest.code"> <path value="ServiceRequest.code" /> <definition value="A set of codes from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test requests." /> <binding> <strength value="preferred" /> <description value="A set of codes that define laboratory medicine test requests. Selected from the SNOMED CT UK coding system." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineProcedures" /> </binding> </element> <element id="ServiceRequest.orderDetail"> <path value="ServiceRequest.orderDetail" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode" /> </binding> </element> <element id="ServiceRequest.subject"> <path value="ServiceRequest.subject" /> <short value="The individual or entity the service is ordered for." /> <mustSupport value="true" /> </element> <element id="ServiceRequest.requester"> <path value="ServiceRequest.requester" /> <short value="Who / what is requesting the service" /> <mustSupport value="true" /> </element> <element id="ServiceRequest.reasonCode"> <path value="ServiceRequest.reasonCode" /> <binding> <strength value="preferred" /> <description value="A set of codes that define a reason for a service request." /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode" /> </binding> </element> <element id="ServiceRequest.bodySite"> <path value="ServiceRequest.bodySite" /> <binding> <strength value="preferred" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-ServiceRequest-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest-Lab", "version": "2.0.0", "name": "UKCoreServiceRequestLab", "title": "UK Core Service Request Lab", "status": "active", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the specific UK constraints and extensions on the International FHIR resource [ServiceRequest](https://hl7.org/fhir/R4/ServiceRequest.html), in order to support requesting laboratory services.", "purpose": "To provide implementers additional support for requesting a procedure or diagnostic or other service to be planned, proposed, or performed, with regards to a laboratory observation or a laboratory diagnostic report.", "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", "kind": "resource", "abstract": false, "type": "ServiceRequest", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/ServiceRequest-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "ServiceRequest.extension:sourceOfServiceRequest", "path": "ServiceRequest.extension", "sliceName": "sourceOfServiceRequest", "short": "Describes the source of the Service Request.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest" ] } ], "isModifier": false }, { "id": "ServiceRequest.extension:additionalContact", "path": "ServiceRequest.extension", "sliceName": "additionalContact", "short": "Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact" ] } ], "isModifier": false }, { "id": "ServiceRequest.extension:coverage", "path": "ServiceRequest.extension", "sliceName": "coverage", "short": "Supports the exchange of information describing the method of funding for the Service Request.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage" ] } ], "isModifier": false }, { "id": "ServiceRequest.status", "path": "ServiceRequest.status", "short": "The status of the order.", "mustSupport": true }, { "id": "ServiceRequest.intent", "path": "ServiceRequest.intent", "short": "Whether the request is a proposal, plan, an original order or a reflex order.", "mustSupport": true }, { "id": "ServiceRequest.category", "path": "ServiceRequest.category", "slicing": { "discriminator": [ { "type": "value", "path": "coding.system" } ], "rules": "open" } }, { "id": "ServiceRequest.category:genomicsWholeCaseSequencing", "path": "ServiceRequest.category", "sliceName": "genomicsWholeCaseSequencing", "short": "Classification of Genomics service", "definition": "A code that classifies the service for Genomics, whether it is a Whole Case Genome Sequencing or non-Whole Genome Sequencing for cancer or rare diseases", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory" } }, { "id": "ServiceRequest.category:genomicsWholeCaseSequencing.coding.system", "path": "ServiceRequest.category.coding.system", "fixedUri": "https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory" }, { "id": "ServiceRequest.priority.extension:priorityReason", "path": "ServiceRequest.priority.extension", "sliceName": "priorityReason", "short": "Supports the underlying reason why a Service Request is urgent.", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason" ] } ], "isModifier": false }, { "id": "ServiceRequest.code", "path": "ServiceRequest.code", "definition": "A set of codes from the SNOMED Clinical Terminology UK coding system regarding laboratory medicine test requests.", "binding": { "strength": "preferred", "description": "A set of codes that define laboratory medicine test requests. Selected from the SNOMED CT UK coding system.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineProcedures" } }, { "id": "ServiceRequest.orderDetail", "path": "ServiceRequest.orderDetail", "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode" } }, { "id": "ServiceRequest.subject", "path": "ServiceRequest.subject", "short": "The individual or entity the service is ordered for.", "mustSupport": true }, { "id": "ServiceRequest.requester", "path": "ServiceRequest.requester", "short": "Who / what is requesting the service", "mustSupport": true }, { "id": "ServiceRequest.reasonCode", "path": "ServiceRequest.reasonCode", "binding": { "strength": "preferred", "description": "A set of codes that define a reason for a service request.", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode" } }, { "id": "ServiceRequest.bodySite", "path": "ServiceRequest.bodySite", "binding": { "strength": "preferred" } } ] } }
Feedback
Click here to:Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen-Lab | draft | 3.1.0 | 2025-05-13 | This profile defines the UK constraints and extensions on the International FHIR resource Specimen. |
Profile_Purpose |
---|
This profile allows the exchange of information about a sample to be used for analysis. |
Detailed Descriptions
Specimen | |
Definition | Laboratory specimen |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Specimen.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Specimen.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Specimen.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Specimen.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Specimen.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Specimen.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Specimen.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 |
|
Specimen.extension:sampleCategory | |
Definition | This extension allows the recording of the category of a sample for use within Genomics, whether it is a tumour or germline sample. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
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 |
|
Specimen.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Specimen.identifier | |
Definition | Id for specimen. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.accessionIdentifier | |
Definition | The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.status | |
Definition | The availability of the specimen. |
Cardinality | 0...1 |
Type | code |
Binding | Codes providing the status/availability of a specimen. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. |
Invariants |
|
Mappings |
|
Specimen.type | |
Definition | The kind of material that forms the specimen. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A code from the SNOMED CT UK Clinical Terminology coding system |
Must Support | True |
Summary | True |
Comments | If the specimen.type conveys information about the site the specimen has been collected from, then, if the bodySite is present, it shall be coherent with the type |
Invariants |
|
Mappings |
|
Specimen.subject | |
Definition | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device. |
Cardinality | 0...1 |
Type | Reference(PatientEuLab | PatientAnimalEu | Group | Device | Substance | Location) |
Must Support | True |
Summary | True |
Requirements | Must know the subject context. |
Invariants |
|
Mappings |
|
Specimen.receivedTime | |
Definition | Time when specimen was received for processing or testing. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.parent | |
Definition | Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
Cardinality | 0...* |
Type | Reference(SpecimenEu) |
Comments | The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample. |
Invariants |
|
Mappings |
|
Specimen.request | |
Definition | Details concerning a service request that required a specimen to be collected. |
Cardinality | 0...* |
Type | Reference(ServiceRequest) |
Comments | If the specimen information are known when the order is created then the ServiceRequest.specimen should be used. If the ServiceRequest can be updated when the specimen is collected then the ServiceRequest.specimen or the Specimen.request could be used. Otherwise the relationship is recorded in the Specimen.request element |
Invariants |
|
Mappings |
|
Specimen.collection | |
Definition | Details concerning the specimen collection. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Specimen.collection.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 |
|
Specimen.collection.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Specimen.collection.extension:bodySite | |
Definition | Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case. |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Specimen.collection.extension:bodySite.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 |
|
Specimen.collection.extension:bodySite.extension | |
Definition | An Extension |
Cardinality | 0...0 |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Specimen.collection.extension:bodySite.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 | http://hl7.org/fhir/StructureDefinition/bodySite |
Mappings |
|
Specimen.collection.extension:bodySite.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list). |
Cardinality | 1...1 |
Type | Reference(BodyStructureEuLab) |
Invariants |
|
Mappings |
|
Specimen.collection.extension:specialHandling | |
Definition | Special handling during the collection, transport, or storage of the specimen. |
Cardinality | 0...* |
Type | Extension(CodeableConcept) |
Invariants |
|
Specimen.collection.extension:collectorR5 | |
Definition | Person who collected the specimen. |
Cardinality | 0...1 |
Type | Extension(Reference(UKCorePatient | UKCoreRelatedPerson)) |
Comments | If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 |
Invariants |
|
Mappings |
|
Specimen.collection.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Specimen.collection.collector | |
Definition | Person who collected the specimen. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole) |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.collection.collected[x] | |
Definition | Time when specimen was collected from subject - the physiologically relevant time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.collection.duration | |
Definition | The span of time over which the collection of a specimen occurred. |
Cardinality | 0...1 |
Type | Duration |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.collection.quantity | |
Definition | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
Specimen.collection.method | |
Definition | A coded value specifying the technique that is used to perform the procedure. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The technique that is used to perform the procedure. |
Invariants |
|
Mappings |
|
Specimen.collection.bodySite | |
Definition | Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | UKCoreSpecimenBodySite (preferred) |
Comments | If the specimen.type conveys information about the site the specimen has been collected from, then, if the bodySite if present it shall be coherent with the type |
Invariants |
|
Mappings |
|
Specimen.collection.bodySite.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 |
|
Specimen.collection.bodySite.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 |
|
Specimen.collection.bodySite.extension:bodySiteReference | |
Definition | An extension to replicate the changes within R5 altering the data type of Specimen.collection.bodySite from CodeableConcept to CodeableReference (bodyStructure). |
Cardinality | 0...1 |
Type | Extension(Reference(BodyStructure)) |
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 |
|
Specimen.collection.bodySite.extension:bodySiteReference.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 |
|
Specimen.collection.bodySite.extension:bodySiteReference.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 |
|
Specimen.collection.bodySite.extension:bodySiteReference.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-BodySiteReference |
Mappings |
|
Specimen.collection.bodySite.extension:bodySiteReference.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 | Reference(BodyStructure) |
Invariants |
|
Mappings |
|
Specimen.collection.bodySite.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Specimen.collection.bodySite.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Specimen.collection.fastingStatus[x] | |
Definition | Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes describing the fasting status of the patient. |
Summary | True |
Requirements | Many diagnostic tests require fasting to facilitate accurate interpretation. |
Comments | Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation |
Invariants |
|
Mappings |
|
Specimen.processing | |
Definition | Details concerning processing and processing steps for the specimen. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Specimen.processing.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 |
|
Specimen.processing.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. |
Invariants |
|
Mappings |
|
Specimen.processing.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Specimen.processing.description | |
Definition | Textual description of procedure. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Specimen.processing.procedure | |
Definition | A coded value specifying the procedure used to process the specimen. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Type indicating the technique used to process the specimen. |
Invariants |
|
Mappings |
|
Specimen.processing.additive | |
Definition | Material used in the processing step. |
Cardinality | 0...* |
Type | Reference(Substance | SpecimenAdditiveSubstance) |
Invariants |
|
Mappings |
|
Specimen.processing.time[x] | |
Definition | A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Specimen.container | |
Definition | The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Specimen.container.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 |
|
Specimen.container.extension | |
Definition | An Extension |
Cardinality | 0...* |
Type | Extension |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Specimen.container.extension:device | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Mappings |
|
Specimen.container.extension:deviceR5 | |
Definition | An Extension |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Specimen.container.extension:locationR5 | |
Definition | An Extension |
Cardinality | 0...1 |
Type | Extension |
Invariants |
|
Specimen.container.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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 |
|
Specimen.container.identifier | |
Definition | Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
Specimen.container.description | |
Definition | Textual description of the container. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Specimen.container.type | |
Definition | The type of container associated with the specimen (e.g. slide, aliquot, etc.). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | LabSpecimenContainerEu (preferred) |
Invariants |
|
Mappings |
|
Specimen.container.capacity | |
Definition | The capacity (volume or other measure) the container may contain. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
Specimen.container.specimenQuantity | |
Definition | The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
Specimen.container.additive[x] | |
Definition | Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | Substance added to specimen container. |
Invariants |
|
Mappings |
|
Specimen.condition | |
Definition | A mode or state of being that describes the nature of the specimen. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes describing the state of the specimen. |
Summary | True |
Requirements | The specimen condition can be used to assess its quality or appropriateness for a specific test. |
Comments | Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test. |
Invariants |
|
Mappings |
|
Specimen.note | |
Definition | To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen). |
Cardinality | 0...* |
Type | Annotation |
Invariants |
|
Mappings |
|
Table View
Specimen | .. | |
Specimen.extension | Extension | ..1 |
Specimen.status | .. | |
Specimen.type | .. | |
Specimen.subject | .. | |
Specimen.receivedTime | .. | |
Specimen.collection | .. | |
Specimen.collection.extension | Extension | .. |
Specimen.collection.extension | Extension | ..1 |
Specimen.collection.bodySite | .. | |
Specimen.collection.bodySite.extension | Extension | ..1 |
Specimen.collection.bodySite.extension.value[x] | .. | |
Specimen.container | .. | |
Specimen.container.extension | Extension | ..1 |
Specimen.container.extension | Extension | ..1 |
Specimen.container.type | .. | |
Specimen.condition | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Specimen-Lab" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen-Lab" /> <version value="3.1.0" /> <name value="UKCoreSpecimenLab" /> <title value="UK Core Specimen Lab" /> <status value="draft" /> <date value="2025-05-13" /> <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="This profile defines the UK constraints and extensions on the International FHIR resource [Specimen](https://hl7.org/fhir/R4/Specimen.html)." /> <purpose value="This profile allows the exchange of information about a sample to be used for analysis." /> <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" /> <kind value="resource" /> <abstract value="false" /> <type value="Specimen" /> <baseDefinition value="http://hl7.eu/fhir/laboratory/StructureDefinition/Specimen-eu-lab" /> <derivation value="constraint" /> <differential> <element id="Specimen.extension:sampleCategory"> <path value="Specimen.extension" /> <sliceName value="sampleCategory" /> <short value="An extension to record the category of a sample." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory" /> </type> <isModifier value="false" /> </element> <element id="Specimen.status"> <path value="Specimen.status" /> <short value="The availability of the specimen sample." /> <mustSupport value="true" /> </element> <element id="Specimen.type"> <path value="Specimen.type" /> <short value="The kind of material that forms the specimen." /> <mustSupport value="true" /> <binding> <strength value="preferred" /> <description value="A code from the SNOMED CT UK Clinical Terminology coding system" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType" /> </binding> </element> <element id="Specimen.subject"> <path value="Specimen.subject" /> <short value="Where the specimen came from." /> <mustSupport value="true" /> </element> <element id="Specimen.receivedTime"> <path value="Specimen.receivedTime" /> <short value="The time when specimen was received for processing." /> <mustSupport value="true" /> </element> <element id="Specimen.collection"> <path value="Specimen.collection" /> <constraint> <key value="ukcore-spec-001" /> <severity value="error" /> <human value="Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time." /> <expression value="collector.reference.empty() or collector.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector').empty()" /> </constraint> </element> <element id="Specimen.collection.extension:specialHandling"> <path value="Specimen.collection.extension" /> <sliceName value="specialHandling" /> <short value="This SHOULD be included if there is a high contamination risk reason for a sample / biopsy." /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/specimen-specialHandling" /> </type> </element> <element id="Specimen.collection.extension:CollectorR5"> <path value="Specimen.collection.extension" /> <sliceName value="collectorR5" /> <comment value="If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector" /> </type> <isModifier value="false" /> </element> <element id="Specimen.collection.bodySite"> <path value="Specimen.collection.bodySite" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenBodySite" /> </binding> </element> <element id="Specimen.collection.bodySite.extension:bodySiteReference"> <path value="Specimen.collection.bodySite.extension" /> <sliceName value="bodySiteReference" /> <short value="An extension to allow referencing to a BodyStructure." /> <max value="1" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference" /> </type> <isModifier value="false" /> </element> <element id="Specimen.collection.bodySite.extension:bodySiteReference.value[x]"> <path value="Specimen.collection.bodySite.extension.value[x]" /> <short value="A reference to a BodyStructure" /> </element> <element id="Specimen.container.extension:deviceR5"> <path value="Specimen.container.extension" /> <sliceName value="deviceR5" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device" /> </type> </element> <element id="Specimen.container.extension:locationR5"> <path value="Specimen.container.extension" /> <sliceName value="locationR5" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location" /> </type> </element> <element id="Specimen.container.type"> <path value="Specimen.container.type" /> <binding> <strength value="preferred" /> </binding> </element> <element id="Specimen.condition"> <path value="Specimen.condition" /> <binding> <strength value="extensible" /> <valueSet value="https://fhir.hl7.org.uk/ValueSet/UKCore-SampleState" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Specimen-Lab", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Specimen-Lab", "version": "3.1.0", "name": "UKCoreSpecimenLab", "title": "UK Core Specimen Lab", "status": "draft", "date": "2025-05-13", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Specimen](https://hl7.org/fhir/R4/Specimen.html).", "purpose": "This profile allows the exchange of information about a sample to be used for analysis.", "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", "kind": "resource", "abstract": false, "type": "Specimen", "baseDefinition": "http://hl7.eu/fhir/laboratory/StructureDefinition/Specimen-eu-lab", "derivation": "constraint", "differential": { "element": [ { "id": "Specimen.extension:sampleCategory", "path": "Specimen.extension", "sliceName": "sampleCategory", "short": "An extension to record the category of a sample.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory" ] } ], "isModifier": false }, { "id": "Specimen.status", "path": "Specimen.status", "short": "The availability of the specimen sample.", "mustSupport": true }, { "id": "Specimen.type", "path": "Specimen.type", "short": "The kind of material that forms the specimen.", "mustSupport": true, "binding": { "strength": "preferred", "description": "A code from the SNOMED CT UK Clinical Terminology coding system", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType" } }, { "id": "Specimen.subject", "path": "Specimen.subject", "short": "Where the specimen came from.", "mustSupport": true }, { "id": "Specimen.receivedTime", "path": "Specimen.receivedTime", "short": "The time when specimen was received for processing.", "mustSupport": true }, { "id": "Specimen.collection", "path": "Specimen.collection", "constraint": [ { "key": "ukcore-spec-001", "severity": "error", "human": "Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time.", "expression": "collector.reference.empty() or collector.extension('http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector').empty()" } ] }, { "id": "Specimen.collection.extension:specialHandling", "path": "Specimen.collection.extension", "sliceName": "specialHandling", "short": "This SHOULD be included if there is a high contamination risk reason for a sample / biopsy.", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/specimen-specialHandling" ] } ] }, { "id": "Specimen.collection.extension:CollectorR5", "path": "Specimen.collection.extension", "sliceName": "collectorR5", "comment": "If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector" ] } ], "isModifier": false }, { "id": "Specimen.collection.bodySite", "path": "Specimen.collection.bodySite", "binding": { "strength": "preferred", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenBodySite" } }, { "id": "Specimen.collection.bodySite.extension:bodySiteReference", "path": "Specimen.collection.bodySite.extension", "sliceName": "bodySiteReference", "short": "An extension to allow referencing to a BodyStructure.", "max": "1", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference" ] } ], "isModifier": false }, { "id": "Specimen.collection.bodySite.extension:bodySiteReference.value[x]", "path": "Specimen.collection.bodySite.extension.value[x]", "short": "A reference to a BodyStructure" }, { "id": "Specimen.container.extension:deviceR5", "path": "Specimen.container.extension", "sliceName": "deviceR5", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device" ] } ] }, { "id": "Specimen.container.extension:locationR5", "path": "Specimen.container.extension", "sliceName": "locationR5", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location" ] } ] }, { "id": "Specimen.container.type", "path": "Specimen.container.type", "binding": { "strength": "preferred" } }, { "id": "Specimen.condition", "path": "Specimen.condition", "binding": { "strength": "extensible", "valueSet": "https://fhir.hl7.org.uk/ValueSet/UKCore-SampleState" } } ] } }