| 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 | |||
| Short | Laboratory Report 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. | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.text | |||
| Short | Narrative 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:versionNumber | |||
| Short | Version-specific identifier for composition | ||
| Definition | Version specific identifier for the composition, assigned when each version is created/updated. | ||
| Cardinality | 0..1 | ||
| Type | Extension(string) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:basedOn-order-or-requisition | |||
| Short | Document Based On Order | ||
| 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)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:basedOn-order-or-requisition.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:basedOn-order-or-requisition.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:basedOn-order-or-requisition.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.eu/fhir/StructureDefinition/composition-basedOn-order-or-requisition | ||
| Mappings |
| ||
| Composition.extension:basedOn-order-or-requisition.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Identifier | Reference(ServiceRequest) | ||
| Slicing | Unordered, Open, by $this(Type) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:basedOn-order-or-requisition.value[x]:valueReference | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Reference(ServiceRequestLabEu) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:information-recipient | |||
| Short | 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(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:information-recipient.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:information-recipient.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:information-recipient.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.eu/fhir/StructureDefinition/information-recipient | ||
| Mappings |
| ||
| Composition.extension:information-recipient.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Reference(PatientEuLab | PractitionerEu | PractitionerRoleEu | Device | Organization | RelatedPerson) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference | |||
| Short | Document 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)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.eu/fhir/laboratory/StructureDefinition/composition-diagnosticReportReference | ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Reference(DiagnosticReportLabEu) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x].id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x].extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x].reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x].type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x].identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:diagnosticReport-reference.value[x].display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.extension:careSettingType | |||
| Short | Used to support the type of care setting associated with a composition or a list. | ||
| Definition | The type of care setting associated with a composition or a list. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.identifier | |||
| Short | Report 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.status | |||
| Short | The workflow / clinical status of this composition. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.type | |||
| Short | Specifies the particular kind of composition. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.category | |||
| Short | Report 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.category:studyType | |||
| Short | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) | ||
| 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 | High-level kind of a clinical document at a macro level. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.category:specialty | |||
| Short | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) | ||
| 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 | High-level kind of a clinical document at a macro level. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.subject | |||
| Short | Who and / or what the composition is about. | ||
| 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(PatientAnimalEu | PatientEuLab | Device | Group | Location) | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.encounter | |||
| Short | The healthcare event which this Laboratory Report is about (when test ordered). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.date | |||
| Short | Composition editing time | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.author | |||
| Short | Identifies who is responsible for the information in the composition. | ||
| Definition | Identifies who is responsible for the information in the Laboratory Report, not necessarily who typed it in. | ||
| Cardinality | 1..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.title | |||
| Short | Laboratory Report | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.confidentiality | |||
| Short | The code specifying the level of confidentiality of the Composition. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester | |||
| Short | Attests the report accuracy | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.attester.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.mode | |||
| Short | The type of attestation | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.time | |||
| Short | When the report was attested by the party | ||
| 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.). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.attester.party | |||
| Short | Who attested the report | ||
| Definition | Who attested the composition in the specified way. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.custodian | |||
| Short | Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo | |||
| Short | Relationships to other compositions/documents | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.relatesTo.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.code | |||
| Short | replaces | transforms | signs | appends | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.relatesTo.target[x] | |||
| Short | Target of the relationship | ||
| Definition | The target composition/document of this relationship. | ||
| Cardinality | 1..1 | ||
| Type | Identifier | Reference(Composition) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event | |||
| Short | The laboratory service(s) being documented | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.event.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.code | |||
| Short | Code(s) that apply to the laboratory service(s) being documented | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.period | |||
| Short | Period of time covered by the documentation | ||
| 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 | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.event.detail | |||
| Short | The laboratory service(s) being documented | ||
| 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 | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section | |||
| Short | Composition is broken into sections | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.title | |||
| Short | Label for section (e.g. for ToC) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.code | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| 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 | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.text | |||
| Short | Text summary of the section, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.mode | |||
| Short | working | snapshot | changes | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.orderedBy | |||
| Short | Order of section entries | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.entry | |||
| Short | A reference to data that supports this section | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.emptyReason | |||
| Short | Why the section is empty | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section.section | |||
| Short | Nested 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:lab-no-subsections | |||
| Short | Variant 1: EU Laboratory Report section with entries and no sub-sections | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.title | |||
| Short | Label for section (e.g. for ToC) | ||
| 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 | 0..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.text | |||
| Short | Text summary of the section, for human interpretation. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.mode | |||
| Short | working | snapshot | changes | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.orderedBy | |||
| Short | Order of section entries | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.entry | |||
| Short | A reference to data that supports this section | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.emptyReason | |||
| Short | Why the section is empty | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-no-subsections.section | |||
| Short | Nested 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:lab-subsections | |||
| Short | Variant 2: EU Laboratory Report section with one to many subsections Laboratory Report Item | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:lab-subsections.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.title | |||
| Short | Label for section (e.g. for ToC) | ||
| 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 | 0..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.text | |||
| Short | Text summary of the section, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.mode | |||
| Short | working | snapshot | changes | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.orderedBy | |||
| Short | Order of section entries | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.entry | |||
| Short | A reference to data that supports this section | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.emptyReason | |||
| Short | Why the section is empty | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section | |||
| Short | Nested 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.title | |||
| Short | Label for section (e.g. for ToC) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.code | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| 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 | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.text | |||
| Short | Text summary of the section, for human interpretation. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.mode | |||
| Short | working | snapshot | changes | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.orderedBy | |||
| Short | Order of section entries | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.entry | |||
| Short | A reference to data that supports this section | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.emptyReason | |||
| Short | Why the section is empty | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:lab-subsections.section.section | |||
| Short | Nested 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
| Composition.section:annotations | |||
| Short | Annotation comment | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Composition.section:annotations.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.title | |||
| Short | Label for section (e.g. for ToC) | ||
| 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 | 0..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.code | |||
| Short | Classification of section (recommended) | ||
| Definition | A code identifying the kind of content contained within the section. This must be consistent with the section title. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"coding": [
{
"system": "http://loinc.org",
"code": "48767-8"
}
]
} | ||
| Mappings |
| ||
| Composition.section:annotations.author | |||
| Short | Who and/or what authored the section | ||
| Definition | Identifies who is responsible for the information in this section, not necessarily who typed it in. | ||
| Cardinality | 0..* | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| Requirements | Identifies who is responsible for the content. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.focus | |||
| Short | Who/what the section is about, when it is not about the subject of composition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.text | |||
| Short | Text summary of the section, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.mode | |||
| Short | working | snapshot | changes | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.orderedBy | |||
| Short | Order of section entries | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.entry | |||
| Short | A reference to data that supports this section | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.emptyReason | |||
| Short | Why the section is empty | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cmp-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Composition.section:annotations.section | |||
| Short | Nested 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: cmp-1 | ||
| Mappings |
| ||
Table View
| Composition | .. | |
| Composition.extension:careSettingType | Extension | ..1 |
| Composition.status | .. | |
| Composition.type | .. | |
| Composition.category | .. | |
| Composition.subject | .. | |
| Composition.author | .. | |
| Composition.confidentiality | .. | |
| Composition.custodian | .. | |
| Composition.section | .. | |
| Composition.section.code | .. |
XML View
JSON View
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 | |||
| Short | Laboratory Report 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. | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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 | 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:DiagnosticReportCompositionR5 | |||
| Short | Associated Lab Report Composition | ||
| 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)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:DiagnosticReportCompositionR5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.extension:DiagnosticReportCompositionR5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:DiagnosticReportCompositionR5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | ||
| Mappings |
| ||
| DiagnosticReport.extension:DiagnosticReportCompositionR5.value[x] | |||
| Short | Reference to a Composition resource for the DiagnosticReport structure | ||
| Definition | The Composition provides structure to the content of the DiagnosticReport (and only contains contents referenced in the DiagnosticReport) - e.g., to order the sections of an anatomic pathology structured report. | ||
| Cardinality | 1..1 | ||
| Type | Reference(CompositionLabReportEu) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:compositionReferenceR5 | |||
| Short | A Composition reference for a DiagnosticReport. This is a R5 backport. | ||
| 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)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:compositionReferenceR5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.extension:compositionReferenceR5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:compositionReferenceR5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.composition | ||
| Mappings |
| ||
| DiagnosticReport.extension:compositionReferenceR5.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. | ||
| Cardinality | 1..1 | ||
| Type | Reference(UKCoreComposition) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:noteR5 | |||
| Short | Comments about the diagnostic report. This is a R5 backport. | ||
| 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:noteR5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.extension:noteR5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:noteR5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.note | ||
| Mappings |
| ||
| DiagnosticReport.extension:noteR5.value[x] | |||
| Short | Comments about the diagnostic report. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:supportingInfoR5 | |||
| Short | Additional info supporting the diagnostic report. This is a R5 backport. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:supportingInfoR5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.extension:supportingInfoR5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 2..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.extension:supportingInfoR5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-DiagnosticReport.supportingInfo | ||
| Mappings |
| ||
| DiagnosticReport.extension:supportingInfoR5.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.identifier | |||
| Short | Report 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.basedOn | |||
| Short | What was requested | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.status | |||
| Short | The status of the diagnostic report. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category | |||
| Short | Report 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:studyType | |||
| Short | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) | ||
| 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 | Codes for diagnostic service sections. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:specialty | |||
| Short | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) | ||
| 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 | Codes for diagnostic service sections. | ||
| Summary | True | ||
| Alias | Department, Sub-department, Service, Discipline | ||
| Comments | Specialty could be used as parameter for searching/querying of laboratory test results. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory | |||
| Short | A mandatory slice that states this resource is categorized as laboratory related content. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding | |||
| Short | A reference to a code defined by a terminology system | ||
| Definition | A reference to a code defined by a terminology system. | ||
| Cardinality | 0..* | ||
| Type | CodingIPS | ||
| Must Support | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.system | |||
| Short | Identity of the terminology 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0074 | ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.version | |||
| Short | Version of the system - if relevant | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | LAB | ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.display | |||
| Short | Representation defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.display.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.display.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.display.extension:translation | |||
| Short | Language Translation (Localization) | ||
| Definition | Language translation from base language of resource to another language. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.coding.display.value | |||
| Short | Primitive value for string | ||
| Definition | Primitive value for string | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| DiagnosticReport.category:laboratory.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.category:laboratory.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.code | |||
| Short | A code or name that describes this diagnostic report. | ||
| Definition | Specifies that it refers to a Laboratory Report | ||
| Cardinality | 1..1 | ||
| Type | CodeableConceptIPS | ||
| Binding | Codes that describe Diagnostic Reports. | ||
| Must Support | True | ||
| Summary | True | ||
| Alias | Type | ||
| Comments | At least one DiagnosticReport.code.coding and Composition.type.coding SHALL be equal | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.subject | |||
| Short | Who and/or what this report is about | ||
| 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(PatientAnimalEu | PatientEuLab | Device | Group | Location) | ||
| Summary | True | ||
| Alias | Patient | ||
| Requirements | SHALL know the subject context. | ||
| Comments | DiagnosticReport and Composition SHALL have the same subject | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.encounter | |||
| Short | The healthcare event which this Laboratory Report is about (when test ordered). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.effective[x] | |||
| Short | Clinically relevant time/time-period for report. | ||
| 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 | Period | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.issued | |||
| Short | Clinically relevant time / time-period for report. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer | |||
| Short | Responsible Diagnostic Service. | ||
| Definition | The diagnostic service that is responsible for issuing the report. | ||
| Cardinality | 0..* | ||
| Type | Reference(CareTeam | Organization | Practitioner | PractitionerRole) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.performer.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.extension:deviceReference | |||
| Short | A reference to a Device which interprets / performs the results of the DiagnosticReport. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.performer.display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter | |||
| Short | Primary result interpreter | ||
| Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. | ||
| Cardinality | 0..* | ||
| Type | Reference(CareTeam | Organization | Practitioner | PractitionerRole) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.extension:deviceReference | |||
| Short | A reference to a Device which interprets / performs the results of the DiagnosticReport. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.resultsInterpreter.display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.specimen | |||
| Short | Specimens this report is based on. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.result | |||
| Short | Lab related Observations that are part of this diagnostic report. | ||
| Definition | Observations 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.imagingStudy | |||
| Short | Reference to full details of imaging associated with the diagnostic report | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media | |||
| Short | Key images associated with this report | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| DiagnosticReport.media.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.comment | |||
| Short | Comment about the image (e.g. explanation) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.media.link | |||
| Short | Reference to the image source | ||
| Definition | Reference to the image source. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Media) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.conclusion | |||
| Short | Clinical conclusion (interpretation) of test results | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.conclusionCode | |||
| Short | Codes for the clinical conclusion of test results | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| DiagnosticReport.presentedForm | |||
| Short | Entire report as issued (pdf recommended) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| DiagnosticReport | .. | |
| DiagnosticReport.extension:compositionReferenceR5 | Extension | ..1 |
| DiagnosticReport.extension:compositionReferenceR5.value[x] | .. | |
| DiagnosticReport.extension:noteR5 | Extension | .. |
| DiagnosticReport.extension:noteR5.value[x] | .. | |
| DiagnosticReport.extension:supportingInfoR5 | Extension | .. |
| DiagnosticReport.extension:supportingInfoR5.extension | 2.. | |
| DiagnosticReport.status | .. | |
| DiagnosticReport.category:laboratory | 1..1 | |
| DiagnosticReport.category.coding | .. | |
| DiagnosticReport.category:laboratory.coding.system | .. | |
| DiagnosticReport.category:laboratory.coding.code | .. | |
| DiagnosticReport.code | .. | |
| DiagnosticReport.issued | .. | |
| DiagnosticReport.performer | .. | |
| DiagnosticReport.performer.extension:deviceReference | Extension | ..1 |
| DiagnosticReport.resultsInterpreter | .. | |
| DiagnosticReport.resultsInterpreter.extension:deviceReference | Extension | .. |
| DiagnosticReport.result | .. | |
| DiagnosticReport.conclusionCode | .. |
XML View
JSON View
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 | |||
| Short | Laboratory result for a simple test or for a panel/study | ||
| 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. | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Laboratory Test Kit | ||
| Definition | The laboratory test kit used for this test. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:supportingInfo | |||
| Short | Other information that may be relevant to this event. | ||
| 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 | ||
| Cardinality | 0..* | ||
| Type | Extension(Reference(Resource)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5 | |||
| Short | Triggering observation(s) | ||
| Definition | Identifies the observation(s) that triggered the performance of this observation. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 2..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:observation | |||
| Short | Triggering 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:observation.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:observation.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:observation.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | observation | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:observation.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Reference(Observation) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:type | |||
| Short | The type of trigger | ||
| Definition | The type of trigger. Reflex | Repeat | Re-run. | ||
| Cardinality | 1..1 | ||
| Type | Extension | ||
| Binding | |||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:type.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:type.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:type.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | type | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:type.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:reason | |||
| Short | Reason that the observation was triggered | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:reason.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:reason.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:reason.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | reason | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.extension:reason.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | ||
| Mappings |
| ||
| Observation.extension:triggeredBy-r5.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..0 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:certifiedRefMaterialCodeable | |||
| Short | Certified Reference Material: CodeableConcept | ||
| 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:certifiedRefMaterialIdentifer | |||
| Short | Certified Reference Material: Identifier | ||
| 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:labTestKit | |||
| Short | Device Laboratory Test Kit | ||
| 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)) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:value-r5 | |||
| Short | only for result of type Attachment | ||
| 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..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:value-r5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:value-r5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:value-r5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | ||
| Mappings |
| ||
| Observation.extension:value-r5.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Attachment | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5 | |||
| Short | Triggering observation(s). This is a R5 backport. | ||
| Definition | Identifies the observation(s) that triggered the performance of this observation. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 2..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:observation | |||
| Short | Triggering 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:observation.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:observation.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:observation.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | observation | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:observation.value[x] | |||
| Short | Triggering observation. | ||
| Definition | A reference to the triggering observation. | ||
| Cardinality | 1..1 | ||
| Type | Reference(Observation) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:type | |||
| Short | reflex | repeat | re-run | ||
| Definition | The type of trigger. Reflex | Repeat | Re-run. | ||
| Cardinality | 1..1 | ||
| Type | Extension | ||
| Binding | |||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:type.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:type.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:type.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | type | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:type.value[x] | |||
| Short | The type of trigger. Reflex | Repeat | Re-run | ||
| Definition | The type of trigger. Reflex | Repeat | Re-run | ||
| Cardinality | 1..1 | ||
| Type | code | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:reason | |||
| Short | Reason that the observation was triggered | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:reason.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:reason.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:reason.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | reason | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.extension:reason.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. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy | ||
| Mappings |
| ||
| Observation.extension:triggeredByR5.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..0 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.extension:bodyStructureR5 | |||
| Short | Observed body structure. This is a R5 backport. | ||
| Definition | The laboratory test kit used for this test. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.identifier | |||
| Short | Business Identifier for observation | ||
| Definition | A unique identifier assigned to this observation. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Requirements | Allows observations to be distinguished and referenced. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.basedOn | |||
| Short | Fulfills plan, proposal or order | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.partOf | |||
| Short | Part of referenced event | ||
| 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(ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | MedicationStatement | Procedure) | ||
| Summary | True | ||
| Alias | Container | ||
| Comments | To link an Observation to an Encounter use | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.status | |||
| Short | The status of the result value. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:laboratory | |||
| Short | A mandatory code, to identify this observation as being Lab related. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory"
}
]
} | ||
| Mappings |
| ||
| Observation.category:laboratory.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.category:laboratory.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:laboratory.coding | |||
| Short | Code defined by a terminology system | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Pattern | {
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory"
} | ||
| Mappings |
| ||
| Observation.category:laboratory.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.category:laboratory.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:laboratory.coding.system | |||
| Short | Identity of the terminology 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | http://terminology.hl7.org/CodeSystem/observation-category | ||
| Pattern | http://terminology.hl7.org/CodeSystem/observation-category | ||
| Mappings |
| ||
| Observation.category:laboratory.coding.version | |||
| Short | Version of the system - if relevant | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:laboratory.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | laboratory | ||
| Pattern | laboratory | ||
| Mappings |
| ||
| Observation.category:laboratory.coding.display | |||
| Short | Representation defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:laboratory.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:laboratory.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:studyType | |||
| Short | The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.) | ||
| Definition | A code that classifies the general type of observation being made. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Codes for high level observation categories. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.category:specialty | |||
| Short | The clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry) | ||
| Definition | A code that classifies the general type of observation being made. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Codes for high level observation categories. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.code | |||
| Short | The type of lab related observation (code / type). | ||
| 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 https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineObservables (preferred) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.subject | |||
| Short | Who and/or what the observation is about | ||
| 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 | ||
| Cardinality | 1..1 | ||
| Type | Reference(PatientAnimalEu | PatientEuLab | Device | Group | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.subject.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.subject.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.subject.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.subject.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.subject.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.subject.display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.focus | |||
| Short | What the observation is about, when it is not about the subject of record | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.encounter | |||
| Short | Healthcare event during which this observation is made | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.effective[x] | |||
| Short | Clinically relevant time/time-period for observation | ||
| 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 | Period | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.effective[x].id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.effective[x].extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.effective[x].extension:data-absent-reason | |||
| Short | effective[x] absence reason | ||
| Definition | Provides a reason why the effectiveTime is missing. | ||
| Cardinality | 0..1 | ||
| Type | Extension(code) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.issued | |||
| Short | Date/Time this result was made available | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer | |||
| Short | Who is responsible for the observation | ||
| Definition | Who was responsible for asserting the observed value as "true". | ||
| Cardinality | 1..* | ||
| Type | Reference(PatientEuLab | PractitionerEu | PractitionerRoleEu | CareTeam | RelatedPerson | OrganizationUvIps) | ||
| Summary | True | ||
| Requirements | May give a degree of confidence in the observation and also indicates where follow-up questions should be directed. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.performer.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer.extension:performerFunction | |||
| Short | Type of performance | ||
| Definition | Distinguishes the type of involvement of the performer in the event. For example, 'author', 'verifier' or 'responsible party'. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer.reference | |||
| Short | Literal reference, Relative, internal or absolute URL | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, ref-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer.type | |||
| Short | Type the reference refers to (e.g. "Patient") | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer.identifier | |||
| Short | Logical reference, when literal reference is not known | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.performer.display | |||
| Short | Text alternative for the resource | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x] | |||
| Short | Actual result | ||
| Definition | The information determined as a result of making the observation, if the information has a simple value. | ||
| Cardinality | 0..1 | ||
| Type | boolean | CodeableConcept | dateTime | integer | Period | Quantity | Range | Ratio | SampledData | string | 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. | ||
| Slicing | Unordered, Closed, by $this(Type) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueString | |||
| Short | Actual result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueRange | |||
| Short | Set of values bounded by low and high | ||
| Definition | A set of ordered Quantities defined by a low and high limit. | ||
| 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 | The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueRatio | |||
| Short | A measured ratio using UCUM | ||
| Definition | A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM. | ||
| 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 | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueTime | |||
| Short | Actual result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueDateTime | |||
| Short | Actual result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valuePeriod | |||
| Short | Actual result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueQuantity | |||
| Short | A measured amount using UCUM | ||
| Definition | A measured amount (or an amount that can potentially be measured) and uncertainty of the measurement. Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. | ||
| 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 | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.value[x]:valueCodeableConcept | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConceptIPS | ||
| Binding | |||
| 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 | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-7 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.dataAbsentReason | |||
| Short | Provides a reason why the expected value is missing. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-6 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.interpretation | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| 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 | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.note | |||
| Short | Comments about the observation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.bodySite | |||
| Short | Observed body part | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.method | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | Laboratory technigue that has been used | ||
| Cardinality | 0..1 | ||
| Type | CodeableConceptIPS | ||
| Binding | Methods for simple observations. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.specimen | |||
| Short | Specimen used for this observation | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.device | |||
| Short | Measuring instrument | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange | |||
| Short | Provides guide for interpretation | ||
| 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 | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.referenceRange.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.low | |||
| Short | Low Range, if relevant | ||
| 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 | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.high | |||
| Short | High Range, if relevant | ||
| 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 | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-3 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.type | |||
| Short | Reference range qualifier | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.appliesTo | |||
| Short | Reference range population | ||
| 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 | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.age | |||
| Short | Applicable age range, if relevant | ||
| 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. | ||
| Comments | The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.referenceRange.text | |||
| Short | Text based reference range in an observation | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.hasMember | |||
| Short | Related resource that belongs to the Observation group | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.derivedFrom | |||
| Short | Related measurements the observation is made from | ||
| 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 | MolecularSequence | Observation | QuestionnaireResponse) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component | |||
| Short | Laboratory result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.component.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.extension:value-r5 | |||
| Short | only for result of type Attachment | ||
| 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..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.extension:value-r5.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Observation.component.extension:value-r5.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.extension:value-r5.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x] | ||
| Mappings |
| ||
| Observation.component.extension:value-r5.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..1 | ||
| Type | Attachment | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.code | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConceptIPS | ||
| Binding | Codes identifying names of simple observations. | ||
| Summary | True | ||
| Requirements | Knowing what kind of observation is being made is essential to understanding the observation. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x] | |||
| Short | Actual component result | ||
| Definition | The information determined as a result of making the observation, if the information has a simple value. | ||
| Cardinality | 0..1 | ||
| Type | boolean | CodeableConcept | dateTime | integer | Period | Quantity | Range | Ratio | SampledData | string | 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. | ||
| Slicing | Unordered, Closed, by $this(Type) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueString | |||
| Short | Actual component result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueRange | |||
| Short | Set of values bounded by low and high | ||
| Definition | A set of ordered Quantities defined by a low and high limit. | ||
| 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 | The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueRatio | |||
| Short | A measured ratio using UCUM | ||
| Definition | A measured ratio (or a ratio that can potentially be measured) and uncertainty of the measurement. This profile imposes that the code system for units be UCUM. | ||
| 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 | The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit. Where the denominator value is known to be fixed to "1", Quantity should be used instead of Ratio. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueTime | |||
| Short | Actual component result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueDateTime | |||
| Short | Actual component result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valuePeriod | |||
| Short | Actual component result | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueQuantity | |||
| Short | A measured amount using UCUM | ||
| Definition | A measured amount (or an amount that can potentially be measured) and uncertainty of the measurement. Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. This profile imposes that the code system for units be UCUM. | ||
| 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 | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.value[x]:valueCodeableConcept | |||
| Short | Concept - reference to a terminology or just text | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| Cardinality | 0..1 | ||
| Type | CodeableConceptIPS | ||
| Binding | |||
| 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 | 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.dataAbsentReason | |||
| Short | Why the component result is missing | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, obs-6 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.interpretation | |||
| Short | High, low, normal, etc. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Observation.component.referenceRange | |||
| Short | Provides guide for interpretation of component result | ||
| 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. | ||
| Mappings |
| ||
Table View
| Observation | .. | |
| Observation.extension:triggeredByR5 | Extension | .. |
| Observation.extension:triggeredByR5.extension:observation | .. | |
| Observation.extension:triggeredByR5.extension:observation.value[x] | .. | |
| Observation.extension:triggeredByR5.extension:type | .. | |
| Observation.extension:triggeredByR5.extension:type.value[x] | .. | |
| Observation.extension:triggeredByR5.extension:reason | .. | |
| Observation.extension:triggeredByR5.extension:reason.value[x] | .. | |
| Observation.extension:bodyStructureR5 | Extension | .. |
| Observation.status | .. | |
| Observation.category:laboratory | 1..1 | |
| Observation.category.coding | .. | |
| Observation.category:laboratory.coding.system | .. | |
| Observation.category:laboratory.coding.code | .. | |
| Observation.code | .. |
XML View
JSON View
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 | |||
| Short | Information about an individual or animal receiving health care services | ||
| Definition | Demographics and other administrative information about an individual or animal receiving care or other health-related services. | ||
| Cardinality | 0..* | ||
| Alias | SubjectOfCare Client Resident | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:birthPlace | |||
| Short | The registered place of birth of the patient. | ||
| Definition | The registered place of birth of the patient. | ||
| Cardinality | 0..1 | ||
| Type | Extension(Address) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:birthPlace.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.extension:birthPlace.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:birthPlace.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||
| Mappings |
| ||
| Patient.extension:birthPlace.value[x] | |||
| Short | The registered place of birth of the patient. | ||
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||
| Cardinality | 1..1 | ||
| Type | AddressEu | ||
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:sex-for-clinical-use | |||
| Short | A context-specific sex parameter 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:birthSex | |||
| Short | The patient's phenotypic sex at birth. | ||
| Definition | The patient's phenotypic sex at birth. | ||
| Cardinality | 0..1 | ||
| Type | Extension(code) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:cadavericDonor | |||
| Short | Post-mortem donor status. | ||
| Definition | Flag indicating whether the patient authorized the donation of body parts after death. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:cadavericDonor.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.extension:cadavericDonor.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:cadavericDonor.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | ||
| Mappings |
| ||
| Patient.extension:cadavericDonor.value[x] | |||
| Short | Post-mortem donor status. | ||
| Definition | Flag indicating whether the patient authorized the donation of body parts after death. | ||
| Cardinality | 1..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:contactPreference | |||
| Short | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. | ||
| 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:deathNotificationStatus | |||
| Short | The patient's death notification status. | ||
| Definition | The patient's death notification status. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:ethnicCategory | |||
| Short | The ethnicity of the subject. | ||
| Definition | The ethnicity of the subject. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:fetalStatus | |||
| Short | Additional content defined by implementations | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:residentialStatus | |||
| Short | The residential status of the patient. | ||
| Definition | The residential status of the patient. For example if this patient is a UK resident. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:patientInterpreterRequired | |||
| Short | Indicator showing whether the patient needs an interpreter. | ||
| Definition | This Patient requires an interpreter to communicate healthcare information to the practitioner. | ||
| Cardinality | 0..1 | ||
| Type | Extension(boolean) | ||
| Alias | extensions, user content | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:patientInterpreterRequired.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.extension:patientInterpreterRequired.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:patientInterpreterRequired.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | ||
| Mappings |
| ||
| Patient.extension:patientInterpreterRequired.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. | ||
| Cardinality | 1..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.extension:nhsNumberUnavailableReason | |||
| Short | Reason why this Patient does not include an NHS Number identifier. | ||
| 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier | |||
| Short | An identifier for this patient. | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber | |||
| Short | The patient's NHS number. | ||
| Definition | An identifier for this patient. | ||
| Cardinality | 0..1 | ||
| Type | Identifier | ||
| Summary | True | ||
| Requirements | Patients are almost always assigned specific numerical identifiers. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus | |||
| Short | NHS number verification status | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.use | |||
| Short | usual | official | temp | secondary | old (If known) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.type | |||
| Short | Description of identifier | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.system | |||
| Short | The namespace for the identifier value | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.nhs.uk/Id/nhs-number | ||
| Examples | Generalhttp://www.acme.com/identifiers/patient | ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.value | |||
| Short | The value that is unique | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General123456 | ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.period | |||
| Short | Time period when id is/was valid for use | ||
| Definition | Time period during which identifier is/was valid for use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.identifier:nhsNumber.assigner | |||
| Short | Organization that issued id (may be just text) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.active | |||
| Short | Whether this patient's record is in active use. | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name | |||
| Short | A name associated with the patient. | ||
| Definition | A human's name with the ability to identify parts and usage. | ||
| 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 | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.name.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.extension:name-absent-reason | |||
| Short | Reason for not providing the name | ||
| Definition | Reason for not providing the name | ||
| Cardinality | 0..1 | ||
| Type | Extension(code) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.use | |||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.text | |||
| Short | Text representation of the full name. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.family | |||
| Short | Family name | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | spanish nameValero Iglesiasspanish Valero Iglesias | ||
| Mappings |
| ||
| Patient.name.family.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.name.family.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.family.extension:fathersFamily | |||
| Short | Portion of family name derived from father | ||
| Definition | The portion of the family name that is derived from the person's father. | ||
| Cardinality | 0..* | ||
| Type | Extension(string) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | spanish nameValero | ||
| Mappings |
| ||
| Patient.name.family.extension:mothersFamily | |||
| Short | Portion of family name derived from mother | ||
| Definition | The portion of the family name that is derived from the person's mother. | ||
| Cardinality | 0..* | ||
| Type | Extension(string) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | spanish nameIglesias | ||
| Mappings |
| ||
| Patient.name.family.value | |||
| Short | Primitive value for string | ||
| Definition | Primitive value for string | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| Patient.name.given | |||
| Short | Given names. Includes middle names | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | spanish nameBorja | ||
| Mappings |
| ||
| Patient.name.prefix | |||
| Short | Parts that come before the name | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.suffix | |||
| Short | Parts that come after the name | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.name.period | |||
| Short | Time period when name was/is in use | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom | |||
| Short | A contact detail for the individual. | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.telecom.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.system | |||
| Short | phone | fax | email | pager | url | sms | other | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.system.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.telecom.system.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.system.extension:otherContactSystem | |||
| Short | Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.system.value | |||
| Short | Primitive value for code | ||
| Definition | Primitive value for code | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| Patient.telecom.value | |||
| Short | The actual contact point details | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.use | |||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.rank | |||
| Short | Specify preferred order of use (1 = highest) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.telecom.period | |||
| Short | Time period when the contact point was/is in use | ||
| Definition | Time period when the contact point was/is in use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.gender | |||
| Short | The gender that the patient is considered to have for administration and record keeping purposes. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.birthDate | |||
| Short | The date of birth for the individual. | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.birthDate.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.birthDate.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.birthDate.extension: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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.birthDate.extension:birthTime.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.birthDate.extension:birthTime.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.birthDate.extension:birthTime.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||
| Mappings |
| ||
| Patient.birthDate.extension:birthTime.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. | ||
| Cardinality | 1..1 | ||
| Type | dateTime | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.birthDate.value | |||
| Short | Primitive value for date | ||
| Definition | Primitive value for date | ||
| Cardinality | 0..1 | ||
| Type | System.Date | ||
| Patient.deceased[x] | |||
| Short | Indicates if the individual is deceased or not | ||
| Definition | Indicates if the individual is deceased or not. | ||
| Cardinality | 0..1 | ||
| Type | boolean | dateTime | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address | |||
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||
| 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 | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.address.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.extension:addressKey | |||
| Short | A patient's address key and type | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.use | |||
| Short | home | work | temp | old | billing - purpose of this address | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalhome | ||
| Mappings |
| ||
| Patient.address.type | |||
| Short | postal | physical | both | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | Generalboth | ||
| Mappings |
| ||
| Patient.address.text | |||
| Short | Text representation of the address | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General137 Nowhere Street, Erewhon 9132 | ||
| Mappings |
| ||
| Patient.address.line | |||
| Short | Street name, number, direction & P.O. Box etc. | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General137 Nowhere Street | ||
| Mappings |
| ||
| Patient.address.line.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.address.line.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.line.extension:streetName | |||
| Short | streetName | ||
| Definition | streetName. | ||
| Cardinality | 0..* | ||
| Type | Extension(string) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.line.extension:houseNumber | |||
| Short | 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) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.line.extension:postBox | |||
| Short | postBox | ||
| Definition | A numbered box located in a post station. | ||
| Cardinality | 0..* | ||
| Type | Extension(string) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.line.value | |||
| Short | Primitive value for string | ||
| Definition | Primitive value for string | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| Patient.address.city | |||
| Short | Name of city, town etc. | ||
| Definition | The name of the city, town, suburb, village or other community or delivery center. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Alias | Municpality | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | GeneralErewhon | ||
| Mappings |
| ||
| Patient.address.district | |||
| Short | District name (aka county) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | GeneralMadison | ||
| Mappings |
| ||
| Patient.address.state | |||
| Short | Sub-unit of country (abbreviations ok) | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.postalCode | |||
| Short | Postal code for area | ||
| Definition | A postal code designating a region defined by the postal service. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Alias | Zip | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General9132 | ||
| Mappings |
| ||
| Patient.address.country | |||
| Short | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.country.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.address.country.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.country.extension:countryCode | |||
| Short | code for string | ||
| Definition | Provides a coded expression for the content represented in a string. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.country.extension:countryCode.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.address.country.extension:countryCode.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.country.extension:countryCode.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding | ||
| Mappings |
| ||
| Patient.address.country.extension:countryCode.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Coding | ||
| Binding | A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.address.country.value | |||
| Short | Primitive value for string | ||
| Definition | Primitive value for string | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| Patient.address.period | |||
| Short | Time period when address was/is in use | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Examples | General{
"start": "2010-03-23",
"end": "2010-07-01"
} | ||
| Mappings |
| ||
| Patient.maritalStatus | |||
| Short | Marital (civil) status of a patient | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.multipleBirth[x] | |||
| Short | Whether patient is part of a multiple birth | ||
| Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). | ||
| Cardinality | 0..1 | ||
| Type | boolean | integer | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.photo | |||
| Short | Image of the patient | ||
| 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:
| ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact | |||
| Short | A contact party (e.g. guardian, partner, friend) for the patient | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.contact.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.extension:contactRank | |||
| Short | The preferred ranking or order of contact applied to a contact on a Patient's contact list. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.extension:copyCorrespondenceIndicator | |||
| Short | Indicates that a must be copied in to all related correspondence. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.relationship | |||
| Short | Relationship between a patient and a contact person for that patient | ||
| Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.name | |||
| Short | A name associated with the contact person | ||
| 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. | ||
| Comments | Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom | |||
| Short | A contact detail for the person | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.contact.telecom.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.system | |||
| Short | phone | fax | email | pager | url | sms | other | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.system.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.contact.telecom.system.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.system.extension:otherContactSystem | |||
| Short | Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.system.value | |||
| Short | Primitive value for code | ||
| Definition | Primitive value for code | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| Patient.contact.telecom.value | |||
| Short | The actual contact point details | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.use | |||
| Short | home | work | temp | old | mobile - purpose of this contact point | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.rank | |||
| Short | Specify preferred order of use (1 = highest) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.telecom.period | |||
| Short | Time period when the contact point was/is in use | ||
| Definition | Time period when the contact point was/is in use. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Summary | True | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.address | |||
| Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||
| Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||
| Cardinality | 0..1 | ||
| Type | AddressEu | ||
| Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. | ||
| Comments | Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.gender | |||
| Short | male | female | other | unknown | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.organization | |||
| Short | Organization that is associated with the contact | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, pat-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.contact.period | |||
| Short | The period during which this contact person or organization is valid to be contacted relating to this patient | ||
| Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication | |||
| Short | A language which may be used to communicate with the patient about his or her health | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.communication.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency | |||
| Short | The patient's proficiency level of the communication method. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:level | |||
| Short | The proficiency level of the communication | ||
| Definition | How well the patient can communicate this communication (good, poor, etc.). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:level.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:level.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:level.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | level | ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:level.value[x] | |||
| Short | The proficiency level for the communication | ||
| Definition | The proficiency level for the communication. | ||
| Cardinality | 1..1 | ||
| Type | Coding | ||
| Binding | The proficiency level for the communication. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:type | |||
| Short | The proficiency type of the communication | ||
| Definition | What type of communication for the proficiency (spoken, written, etc.). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:type.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:type.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:type.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | type | ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.extension:type.value[x] | |||
| Short | The proficiency type for the communication | ||
| Definition | The proficiency type for the communication. | ||
| Cardinality | 1..1 | ||
| Type | Coding | ||
| Binding | The proficiency type for the communication. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/patient-proficiency | ||
| Mappings |
| ||
| Patient.communication.extension:proficiency.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 0..0 | ||
| Type | Address | Age | Annotation | Attachment | base64Binary | boolean | canonical | code | CodeableConcept | Coding | ContactDetail | ContactPoint | Contributor | Count | DataRequirement | date | dateTime | decimal | Distance | Dosage | Duration | Expression | HumanName | id | Identifier | instant | integer | markdown | Meta | Money | oid | ParameterDefinition | Period | positiveInt | Quantity | Range | Ratio | Reference | RelatedArtifact | SampledData | Signature | string | time | Timing | TriggerDefinition | unsignedInt | uri | url | UsageContext | uuid | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.communication.preferred | |||
| Short | Language preference indicator | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.generalPractitioner | |||
| Short | Patient's nominated care provider | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.managingOrganization | |||
| Short | Organization that is the custodian of the patient record | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.link | |||
| Short | Link to another patient resource that concerns the same actual person | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.link.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Patient.link.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.link.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.link.other | |||
| Short | The other patient or related person resource that the link refers to | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Patient.link.type | |||
| Short | replaced-by | replaces | refer | seealso | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| Patient | .. | |
| Patient.extension:birthPlace | Extension | .. |
| Patient.extension:birthPlace.value[x] | .. | |
| Patient.extension:birthSex | Extension | .. |
| Patient.extension:cadavericDonor | Extension | .. |
| Patient.extension:cadavericDonor.value[x] | .. | |
| Patient.extension:contactPreference | Extension | .. |
| Patient.extension:deathNotificationStatus | Extension | .. |
| Patient.extension:ethnicCategory | Extension | ..1 |
| Patient.extension:fetalStatus | Extension | .. |
| Patient.extension:residentialStatus | Extension | .. |
| Patient.extension:patientInterpreterRequired | Extension | .. |
| Patient.extension:patientInterpreterRequired.value[x] | .. | |
| Patient.extension:nhsNumberUnavailableReason | Extension | .. |
| Patient.identifier | .. | |
| Patient.identifier:nhsNumber | ..1 | |
| Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus | Extension | ..1 |
| Patient.identifier:nhsNumber.system | 1.. | |
| Patient.identifier:nhsNumber.value | 1.. | |
| Patient.active | .. | |
| Patient.name | .. | |
| Patient.telecom | .. | |
| Patient.telecom.system | .. | |
| Patient.telecom.system.extension:otherContactSystem | Extension | .. |
| Patient.gender | .. | |
| Patient.birthDate | .. | |
| Patient.birthDate.extension:birthTime | Extension | .. |
| Patient.birthDate.extension:birthTime.value[x] | .. | |
| Patient.address | .. | |
| Patient.address.extension:addressKey | Extension | .. |
| Patient.maritalStatus | .. | |
| Patient.contact | .. | |
| Patient.contact.extension:contactRank | Extension | .. |
| Patient.contact.extension:copyCorrespondenceIndicator | Extension | .. |
| Patient.contact.relationship | .. | |
| Patient.contact.telecom | .. | |
| Patient.contact.telecom.system | .. | |
| Patient.contact.telecom.system.extension:otherContactSystem | Extension | .. |
| Patient.communication | .. | |
| Patient.communication.extension:proficiency | Extension | ..1 |
| Patient.communication.extension:proficiency.extension:level | .. | |
| Patient.communication.extension:proficiency.extension:level.value[x] | .. | |
| Patient.communication.extension:proficiency.extension:type | .. | |
| Patient.communication.extension:proficiency.extension:type.value[x] | .. | |
| Patient.communication.language | .. | |
| Patient.managingOrganization | .. |
XML View
JSON View
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 | |||
| Short | A person with a formal responsibility in the provisioning of healthcare or related services | ||
| Definition | A person who is directly or indirectly involved in the provisioning of healthcare. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.identifier | |||
| Short | An identifier that applies to this person in this role. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.active | |||
| Short | Whether this practitioner's record is in active use | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name | |||
| Short | The name(s) associated with the practitioner. | ||
| 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:
| ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.name.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.use | |||
| Short | usual | official | temp | nickname | anonymous | old | maiden | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.text | |||
| Short | Text representation of the full name | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.family | |||
| Short | Family name (often called 'Surname') | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.given | |||
| Short | Given names (not always 'first'). Includes middle names | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.prefix | |||
| Short | Parts that come before the name | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.suffix | |||
| Short | Parts that come after the name | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.name.period | |||
| Short | Time period when name was/is in use | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.telecom | |||
| Short | A contact detail for the practitioner (that apply to all roles). | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.address | |||
| Short | Address(es) of the practitioner that are not role specific (typically home 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.gender | |||
| Short | male | female | other | unknown | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.birthDate | |||
| Short | The date on which the practitioner was born | ||
| Definition | The date of birth for the practitioner. | ||
| Cardinality | 0..1 | ||
| Type | date | ||
| Summary | True | ||
| Requirements | Needed for identification. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.photo | |||
| Short | Image of the person | ||
| 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. | ||
| Comments | When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent". | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification | |||
| Short | Certification, licenses, or training pertaining to the provision of care | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Practitioner.qualification.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.identifier | |||
| Short | An identifier for this qualification for the practitioner | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.code | |||
| Short | Coded representation of the qualification | ||
| Definition | Coded representation of the qualification. | ||
| Cardinality | 1..1 | ||
| Type | CodeableConcept | ||
| Binding | Specific qualification the practitioner has to provide a service. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.period | |||
| Short | Period during which the qualification is valid | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.qualification.issuer | |||
| Short | Organization that regulates and issues the qualification | ||
| Definition | Organization that regulates and issues the qualification. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Organization) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Practitioner.communication | |||
| Short | A language the practitioner can use in patient 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| Practitioner | .. | |
| Practitioner.identifier | .. | |
| Practitioner.name | .. | |
| Practitioner.telecom | .. | |
| Practitioner.communication | .. |
XML View
JSON View
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 | |||
| Short | Roles/organizations the practitioner is associated with | ||
| Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.identifier | |||
| Short | Business Identifiers that are specific to a role/location | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.active | |||
| Short | Whether this practitioner role record is in active use. | ||
| 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. | ||
| Meaning when missing | This resource is generally assumed to be active if no value is provided for the active element | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.period | |||
| Short | The period during which the practitioner is authorized to perform in these role(s). | ||
| 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. | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.practitioner | |||
| Short | Practitioner that is able to provide the defined services for the organization. | ||
| Definition | Practitioner that is able to provide the defined services for the organization. | ||
| Cardinality | 0..1 | ||
| Type | Reference(PractitionerUvIps) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.organization | |||
| Short | Organization where the roles are available. | ||
| Definition | The organization where the Practitioner performs the roles associated. | ||
| Cardinality | 0..1 | ||
| Type | Reference(OrganizationUvIps) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.code | |||
| Short | Concept - reference to a terminology or just text | ||
| 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). | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.specialty | |||
| Short | Specific specialty of the practitioner. | ||
| Definition | Specific specialty of the practitioner. | ||
| Cardinality | 0..* | ||
| Type | CodeableConcept | ||
| Binding | Specific specialty associated with the agency. | ||
| Must Support | True | ||
| Summary | True | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.location | |||
| Short | The location(s) at which this practitioner provides care. | ||
| Definition | The location(s) at which this practitioner provides care. | ||
| Cardinality | 0..* | ||
| Type | Reference(Location) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.healthcareService | |||
| Short | The list of healthcare services that this worker provides for this role's Organization/Location(s) | ||
| Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s). | ||
| Cardinality | 0..* | ||
| Type | Reference(HealthcareService) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.telecom | |||
| Short | Contact details that are specific to the role/location/service. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime | |||
| Short | Times the Service Site is available | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.availableTime.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.daysOfWeek | |||
| Short | mon | tue | wed | thu | fri | sat | sun | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.allDay | |||
| Short | Always available? e.g. 24 hour service | ||
| Definition | Is this always available? (hence times are irrelevant) e.g. 24 hour service. | ||
| Cardinality | 0..1 | ||
| Type | boolean | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.availableStartTime | |||
| Short | Opening time of day (ignored if allDay = true) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availableTime.availableEndTime | |||
| Short | Closing time of day (ignored if allDay = true) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable | |||
| Short | Not available during this time due to provided reason | ||
| Definition | The practitioner is not available or performing this role during this period of time due to the provided reason. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| PractitionerRole.notAvailable.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.description | |||
| Short | Reason presented to the user explaining why time not available | ||
| Definition | The reason that can be presented to the user as to why this time is not available. | ||
| Cardinality | 1..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.notAvailable.during | |||
| Short | Service not available from this date | ||
| Definition | Service is not available (seasonally or for a public holiday) from this date. | ||
| Cardinality | 0..1 | ||
| Type | Period | ||
| Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.availabilityExceptions | |||
| Short | Description of availability exceptions | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| PractitionerRole.endpoint | |||
| Short | Technical endpoints providing access to services operated for the practitioner with this role | ||
| 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. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| PractitionerRole | .. | |
| PractitionerRole.active | .. | |
| PractitionerRole.period | .. | |
| PractitionerRole.practitioner | .. | |
| PractitionerRole.organization | .. | |
| PractitionerRole.specialty | .. | |
| PractitionerRole.location | .. | |
| PractitionerRole.telecom | .. |
XML View
JSON View
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 | |||
| Short | Laboratory Order | ||
| Definition | Laboratory Order composition. | ||
| Cardinality | 0..* | ||
| Alias | diagnostic request, referral, referral request, transfer of care request | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.extension:sourceOfServiceRequest | |||
| Short | Describes the source of the Service Request. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.extension: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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.extension:coverage | |||
| Short | Supports the exchange of information describing the method of funding for the Service Request. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.identifier | |||
| Short | Identifiers assigned to this order | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.instantiatesCanonical | |||
| Short | Instantiates FHIR protocol or definition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.instantiatesUri | |||
| Short | Instantiates external protocol or definition | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.basedOn | |||
| Short | What request fulfills | ||
| Definition | Plan/proposal/order fulfilled by this request. | ||
| Cardinality | 0..* | ||
| Type | Reference(CarePlan | MedicationRequest | ServiceRequest) | ||
| Summary | True | ||
| Alias | fulfills | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.replaces | |||
| Short | What request 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 | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.requisition | |||
| Short | Composite Request ID. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.status | |||
| Short | The status of the order. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.intent | |||
| Short | Whether the request is a proposal, plan, an original order or a reflex order. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category | |||
| Short | Classification of service | ||
| 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) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category: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 | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding | |||
| Short | Code defined by a terminology system | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.system | |||
| Short | Identity of the terminology 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Fixed Value | https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory | ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.version | |||
| Short | Version of the system - if relevant | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.code | |||
| Short | Symbol in syntax defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.display | |||
| Short | Representation defined by the system | ||
| 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. | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.userSelected | |||
| Short | If this coding was chosen directly by the user | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.category:genomicsWholeCaseSequencing.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.priority | |||
| Short | routine | urgent | asap | stat | ||
| 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 | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Meaning when missing | If missing, this task should be performed with normal priority | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.priority.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| ServiceRequest.priority.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.priority.extension:priorityReason | |||
| Short | Supports the underlying reason why a Service Request is urgent. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.priority.value | |||
| Short | Primitive value for code | ||
| Definition | Primitive value for code | ||
| Cardinality | 0..1 | ||
| Type | System.String | ||
| Maximum string length | 1048576 | ||
| ServiceRequest.doNotPerform | |||
| Short | True if service/procedure should not be performed | ||
| 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. | ||
| Meaning when missing | If missing, the request is a positive request e.g. "do perform" | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.code | |||
| Short | What is being requested/ordered | ||
| 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. https://fhir.hl7.org.uk/ValueSet/UKCore-PathologyAndLaboratoryMedicineProcedures (preferred) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.orderDetail | |||
| Short | Additional order information | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1, prr-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.quantity[x] | |||
| Short | Service amount | ||
| 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 | Range | Ratio | ||
| Summary | True | ||
| Requirements | When ordering a service the number of service items may need to be specified separately from the the service item. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.subject | |||
| Short | The individual or entity the service is ordered for. | ||
| 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(PatientAnimalEu | PatientEuLab | Device | Group | Location) | ||
| Must Support | True | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.encounter | |||
| Short | Encounter in which the request was created | ||
| 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 | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.occurrence[x] | |||
| Short | When service should occur | ||
| Definition | The date/time at which the requested service should occur. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | Period | Timing | ||
| Summary | True | ||
| Alias | schedule | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.asNeeded[x] | |||
| Short | Preconditions for service | ||
| 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 | CodeableConcept | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.authoredOn | |||
| Short | When the order was placed | ||
| Definition | When the request transitioned to being actionable. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Summary | True | ||
| Alias | orderedOn | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.requester | |||
| Short | Who / what is requesting the service | ||
| Definition | The individual who initiated the request and has responsibility for its activation. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.performerType | |||
| Short | Performer role | ||
| 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”. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.performer | |||
| Short | Requested performer | ||
| Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. | ||
| Cardinality | 0..* | ||
| Type | Reference(CareTeam | Device | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.locationCode | |||
| Short | Requested location | ||
| 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 | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.locationReference | |||
| Short | Requested location | ||
| 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 | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.reasonCode | |||
| Short | Explanation/Justification for procedure or service | ||
| 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 | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.reasonReference | |||
| Short | Explanation/Justification for service or service | ||
| Definition | Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in | ||
| Cardinality | 0..* | ||
| Type | Reference(Condition | DiagnosticReport | DocumentReference | Observation) | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.insurance | |||
| Short | Associated insurance coverage | ||
| 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) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.supportingInfo | |||
| Short | Additional information: e.g AOEs and prior results | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.specimen | |||
| Short | Specimens to be used by the laboratory procedure | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.bodySite | |||
| Short | Location on Body | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.note | |||
| Short | Comments | ||
| Definition | Any other notes and comments made about the service request. For example, internal billing notes. | ||
| Cardinality | 0..* | ||
| Type | Annotation | ||
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.patientInstruction | |||
| Short | Patient or consumer-oriented instructions | ||
| Definition | Instructions in terms that are understood by the patient or consumer. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Summary | True | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| ServiceRequest.relevantHistory | |||
| Short | Request provenance | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| ServiceRequest | .. | |
| ServiceRequest.extension:sourceOfServiceRequest | Extension | ..1 |
| ServiceRequest.extension:additionalContact | Extension | .. |
| ServiceRequest.extension:coverage | Extension | ..1 |
| ServiceRequest.status | .. | |
| ServiceRequest.intent | .. | |
| ServiceRequest.category | .. | |
| ServiceRequest.category:genomicsWholeCaseSequencing | .. | |
| ServiceRequest.category.coding | .. | |
| ServiceRequest.category:genomicsWholeCaseSequencing.coding.system | .. | |
| ServiceRequest.priority | .. | |
| ServiceRequest.priority.extension:priorityReason | Extension | .. |
| ServiceRequest.code | .. | |
| ServiceRequest.orderDetail | .. | |
| ServiceRequest.subject | .. | |
| ServiceRequest.requester | .. | |
| ServiceRequest.reasonCode | .. | |
| ServiceRequest.bodySite | .. |
XML View
JSON View
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 | |||
| Short | Laboratory Specimen | ||
| Definition | Laboratory specimen | ||
| Cardinality | 0..* | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.id | |||
| Short | Logical id of this artifact | ||
| 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 | string | ||
| 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 | |||
| Short | Metadata about the resource | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.implicitRules | |||
| Short | A set of rules under which this content was created | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.language | |||
| Short | Language of the resource content | ||
| 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). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.text | |||
| Short | Text summary of the resource, for human interpretation | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.contained | |||
| Short | Contained, inline Resources | ||
| 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 | |||
| Short | Additional content defined by implementations | ||
| 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) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.extension:sampleCategory | |||
| Short | An extension to record the category of a sample. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.modifierExtension | |||
| Short | Extensions that cannot be ignored | ||
| 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. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.identifier | |||
| Short | External Identifier | ||
| Definition | Id for specimen. | ||
| Cardinality | 0..* | ||
| Type | Identifier | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.accessionIdentifier | |||
| Short | Identifier assigned by the lab | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.status | |||
| Short | The availability of the specimen sample. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.type | |||
| Short | The kind of material that forms the specimen. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.subject | |||
| Short | Where the specimen came from. | ||
| 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(PatientAnimalEu | PatientEuLab | Device | Group | Location | Substance) | ||
| Must Support | True | ||
| Summary | True | ||
| Requirements | Must know the subject context. | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.receivedTime | |||
| Short | The time when specimen was received for processing. | ||
| Definition | Time when specimen was received for processing or testing. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | ||
| Must Support | True | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.parent | |||
| Short | Specimen from which this specimen originated | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.request | |||
| Short | Why the specimen was collected. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection | |||
| Short | Collection details | ||
| Definition | Details concerning the specimen collection. | ||
| Cardinality | 0..1 | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Specimen.collection.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.extension:bodySite | |||
| Short | Target anatomic location or structure | ||
| 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 | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.extension:bodySite.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Specimen.collection.extension:bodySite.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..0 | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.extension:bodySite.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | http://hl7.org/fhir/StructureDefinition/bodySite | ||
| Mappings |
| ||
| Specimen.collection.extension:bodySite.value[x] | |||
| Short | Value of extension | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Reference(BodyStructureEuLab) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.extension:specialHandling | |||
| Short | This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. | ||
| Definition | Special handling during the collection, transport, or storage of the specimen. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.extension:collectorR5 | |||
| Short | Person who collected the specimen. | ||
| Definition | Person who collected the specimen. | ||
| Cardinality | 0..1 | ||
| Type | Extension(Reference(UKCorePatient | UKCoreRelatedPerson)) | ||
| Alias | extensions, user content | ||
| Comments | If this extension is used then Specimen.collection.collector SHALL NOT have a value to keep the cardinality restraint 0..1 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.collector | |||
| Short | Who collected the specimen | ||
| Definition | Person who collected the specimen. | ||
| Cardinality | 0..1 | ||
| Type | Reference(Practitioner | PractitionerRole) | ||
| Summary | True | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.collected[x] | |||
| Short | Collection time | ||
| Definition | Time when specimen was collected from subject - the physiologically relevant time. | ||
| Cardinality | 0..1 | ||
| Type | dateTime | Period | ||
| Summary | True | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.duration | |||
| Short | How long it took to collect specimen | ||
| Definition | The span of time over which the collection of a specimen occurred. | ||
| Cardinality | 0..1 | ||
| Type | Duration | ||
| Summary | True | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.quantity | |||
| Short | The quantity of specimen collected | ||
| 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 | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.method | |||
| Short | Technique used to perform collection | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite | |||
| Short | Anatomical collection site | ||
| 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 | Codes describing anatomical locations. May include laterality. | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Specimen.collection.bodySite.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite.extension:bodySiteReference | |||
| Short | An extension to allow referencing to a BodyStructure. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite.extension:bodySiteReference.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Specimen.collection.bodySite.extension:bodySiteReference.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite.extension:bodySiteReference.url | |||
| Short | identifies the meaning of the extension | ||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||
| Cardinality | 1..1 | ||
| Type | uri | ||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||
| Fixed Value | https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference | ||
| Mappings |
| ||
| Specimen.collection.bodySite.extension:bodySiteReference.value[x] | |||
| Short | A reference to a BodyStructure | ||
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||
| Cardinality | 1..1 | ||
| Type | Reference(BodyStructure) | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite.coding | |||
| Short | Code defined by a terminology system | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.bodySite.text | |||
| Short | Plain text representation of the concept | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.collection.fastingStatus[x] | |||
| Short | Whether or how long patient abstained from food and/or drink | ||
| 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 | Duration | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing | |||
| Short | Processing and processing step details | ||
| Definition | Details concerning processing and processing steps for the specimen. | ||
| Cardinality | 0..* | ||
| Type | BackboneElement | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Specimen.processing.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing.description | |||
| Short | Textual description of procedure | ||
| Definition | Textual description of procedure. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing.procedure | |||
| Short | Indicates the treatment step applied to the specimen | ||
| 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. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing.additive | |||
| Short | Material used in the processing step | ||
| Definition | Material used in the processing step. | ||
| Cardinality | 0..* | ||
| Type | Reference(SpecimenAdditiveSubstance | Substance) | ||
| Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.processing.time[x] | |||
| Short | Date and time of specimen processing | ||
| 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 | Period | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container | |||
| Short | Direct container of specimen (tube/slide, etc.) | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.id | |||
| Short | Unique id for inter-element referencing | ||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Mappings |
| ||
| Specimen.container.extension | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..* | ||
| Type | Extension | ||
| Alias | extensions, user content | ||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||
| Slicing | Unordered, Open, by url(Value) Extensions are always sliced by (at least) url | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.extension:device | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.extension:deviceR5 | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.extension:locationR5 | |||
| Short | Additional content defined by implementations | ||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||
| Cardinality | 0..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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.modifierExtension | |||
| Short | Extensions that cannot be ignored even if unrecognized | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.identifier | |||
| Short | Id for the container | ||
| 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 | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.description | |||
| Short | Textual description of the container | ||
| Definition | Textual description of the container. | ||
| Cardinality | 0..1 | ||
| Type | string | ||
| Comments | Note that FHIR strings SHALL NOT exceed 1MB in size | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.type | |||
| Short | Kind of container directly associated with specimen | ||
| Definition | The type of container associated with the specimen (e.g. slide, aliquot, etc.). | ||
| Cardinality | 0..1 | ||
| Type | CodeableConcept | ||
| Binding | Type of specimen container. | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.capacity | |||
| Short | Container volume or size | ||
| Definition | The capacity (volume or other measure) the container may contain. | ||
| Cardinality | 0..1 | ||
| Type | SimpleQuantity | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.specimenQuantity | |||
| Short | Quantity of specimen within container | ||
| 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 | ||
| Comments | The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.container.additive[x] | |||
| Short | Additive associated with container | ||
| Definition | Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA. | ||
| Cardinality | 0..0 | ||
| Type | CodeableConcept | Reference(Substance) | ||
| Binding | Substance added to specimen container. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.condition | |||
| Short | State of the specimen | ||
| 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. https://fhir.hl7.org.uk/ValueSet/UKCore-SampleState (extensible) | ||
| 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. | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
| Specimen.note | |||
| Short | Comments | ||
| 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 | ||
| Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). | ||
| Conditions | The cardinality or value of this element may be affected by these constraints: ele-1 | ||
| Constraints |
| ||
| Mappings |
| ||
Table View
| Specimen | .. | |
| Specimen.extension:sampleCategory | Extension | ..1 |
| Specimen.status | .. | |
| Specimen.type | .. | |
| Specimen.subject | .. | |
| Specimen.receivedTime | .. | |
| Specimen.collection | .. | |
| Specimen.collection.extension:specialHandling | Extension | .. |
| Specimen.collection.extension:CollectorR5 | Extension | ..1 |
| Specimen.collection.bodySite | .. | |
| Specimen.collection.bodySite.extension:bodySiteReference | Extension | ..1 |
| Specimen.collection.bodySite.extension:bodySiteReference.value[x] | .. | |
| Specimen.container | .. | |
| Specimen.container.extension:deviceR5 | Extension | ..1 |
| Specimen.container.extension:locationR5 | Extension | ..1 |
| Specimen.container.type | .. | |
| Specimen.condition | .. |