0.1.0 - ci-build
SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-11-05 |
Definitions for the SenaiteDiagnosticReport resource profile.
See the documentation on how to interpret the contents of this table
| 0. DiagnosticReport | |
| Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. |
| Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
| 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. |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Report, Test, Result, Results, Labs, Laboratory |
| Invariants | dgr-1: When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` (composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference))) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dr-identifier-shape: A per-sample report (at most one basedOn) carries at most one Sample ID, at most one Client Sample ID and no Sample Group ID; a combined report (more than one basedOn) carries one Sample ID per basedOn, at most one Client Sample ID per basedOn, and exactly one Sample Group ID ( (basedOn.count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-id').count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/client-sample-id').count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-group-id').empty()) or (basedOn.count() > 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-id').count() = basedOn.count() and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/client-sample-id').count() <= basedOn.count() and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-group-id').count() = 1))dr-specimen-count: A per-sample report references exactly one Specimen; a combined report references one Specimen for each ServiceRequest in basedOn ( specimen.count() = iif(basedOn.count() > 1, basedOn.count(), 1)) |
| 2. DiagnosticReport.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| 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 its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. DiagnosticReport.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 6. DiagnosticReport.extension | |
| Definition | An Extension 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 managable, 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. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 8. DiagnosticReport.modifierExtension | |
| Definition | An Extension 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 managable, 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). |
| Short | ExtensionExtensions that cannot be ignored |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. DiagnosticReport.identifier | |
| Definition | Identifiers assigned to this report by the performer or other systems. |
| Short | Business identifier for report |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| 12. DiagnosticReport.identifier.extension | |
| Definition | An Extension 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 managable, 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. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 14. DiagnosticReport.identifier.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. DiagnosticReport.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..01 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type|5.0.0 (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. DiagnosticReport.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 10..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. DiagnosticReport.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 10..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 22. DiagnosticReport.identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..01 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. DiagnosticReport.identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..01 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. DiagnosticReport.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The SENAITE sample Object ID, assigned by the server on creation and shared with the corresponding Specimen. A per-sample report carries one. A combined report carries one for each Sample it covers, each matching that Sample's Specimen, so a consumer can find a combined report by searching on any covered Sample ID. Identifiers assigned to this report by the performer or other systems. |
| Short | SENAITE-assigned sample ID — matches the Specimen usual identifierBusiness identifier for report |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. DiagnosticReport.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. DiagnosticReport.identifier:senaiteId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. DiagnosticReport.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | SENAITE-assigned sample identifier — alphanumeric and hyphens onlyThe value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. DiagnosticReport.identifier:clientSampleId | |
| Slice Name | clientSampleId |
| Definition | The Client Sample ID — the consumer-owned identifier for the Sample (e.g. laboratory order number), if one was supplied on the Specimen entry of a POSTed SenaiteRequestBundle or entered against the Sample by laboratory staff. Holds the same value as the secondary identifier on the corresponding Specimen. Note that SenaiteServiceRequest carries no Identifiers assigned to this report by the performer or other systems. |
| Short | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifierBusiness identifier for report |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. DiagnosticReport.identifier:clientSampleId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. DiagnosticReport.identifier:clientSampleId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 40. DiagnosticReport.identifier:clientSampleId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External ID — alphanumeric and hyphens onlyThe value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 42. DiagnosticReport.identifier:sampleGroupId | |
| Slice Name | sampleGroupId |
| Definition | The Sample Group ID: the consumer-owned value supplied as ServiceRequest.requisition, shared by the requests whose Samples a combined report covers. Present on a combined report (exactly one) and absent from a per-sample report. The value is unique within the consumer, and the server scopes searches on it to the caller's Client(s). Searchable as DiagnosticReport?identifier=https://fhir.senaite.org/NamingSystem/sample-group-id|<value>, which returns the combined report(s) for that group. Identifiers assigned to this report by the performer or other systems. |
| Short | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report coversBusiness identifier for report |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. DiagnosticReport.identifier:sampleGroupId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..01 |
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. DiagnosticReport.identifier:sampleGroupId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. DiagnosticReport.identifier:sampleGroupId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Sample Group ID — alphanumeric and hyphens onlyThe value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. DiagnosticReport.basedOn | |
| Definition | A per-sample report has at most one ServiceRequest. A combined report lists every ServiceRequest whose Sample it covers; the list is fixed when the combined report is published. More than one entry marks a combined report. Details concerning a service requested. |
| Short | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined reportWhat was requested |
| 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. |
| Control | 0..* |
| Type | Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. |
| Alternate Names | Request |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. DiagnosticReport.basedOn.extension | |
| Definition | An Extension 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 managable, 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. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.basedOn.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 54. DiagnosticReport.basedOn.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. DiagnosticReport.basedOn.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| 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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..01 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 58. DiagnosticReport.basedOn.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| 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. |
| Control | 0..01 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 60. DiagnosticReport.status | |
| Definition | The status of the diagnostic report. Accepts: registered | partial | preliminary | final | entered-in-error The status of the diagnostic report. |
| Short | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown |
| Control | 1..1 |
| Binding | The codes SHALL be taken from DiagnosticReportStatushttp://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0 (required to http://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0)The status of the diagnostic report. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. DiagnosticReport.category | |
| Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
| Short | Service category |
| Comments | Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. |
| Control | 0..0* |
| Binding | For example codes, see DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0 (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0)HL7 V2 table 0074 |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | Department, Sub-department, Service, Discipline |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. DiagnosticReport.code | |
| Definition | A code or name that describes this diagnostic report. |
| Short | Name/Code for this diagnostic report |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from LOINCDiagnosticReportCodeshttp://hl7.org/fhir/ValueSet/report-codes|5.0.0 (preferred to http://hl7.org/fhir/ValueSet/report-codes|5.0.0)LOINC Codes for Diagnostic Reports |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | Type |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. DiagnosticReport.code.extension | |
| Definition | An Extension 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 managable, 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. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 68. DiagnosticReport.encounter | |
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
| Short | Health care event when test ordered |
| 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). |
| Control | 0..01 |
| Type | Reference(Encounter) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Links the request to the Encounter context. |
| Alternate Names | Context |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. DiagnosticReport.effective[x] | |
| Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
| Short | Clinically relevant time/time-period for 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. |
| Control | 0..01 |
| Type | Choice of: dateTime, Period |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to know where in the patient history to file/present this report. |
| Alternate Names | Observation time, Effective Time, Occurrence |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. DiagnosticReport.issued | |
| Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
| Short | DateTime this version was made |
| 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. |
| Control | 0..01 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Clinicians need to be able to check the date that the report was released. |
| Alternate Names | Date published, Date Issued, Date Verified |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. DiagnosticReport.performer | |
| Definition | The diagnostic service that is responsible for issuing the report. |
| Short | Responsible Diagnostic Service |
| Comments | This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. |
| Control | 0..0* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 76. DiagnosticReport.resultsInterpreter | |
| Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
| Short | Primary result interpreter |
| Comments | Might not be the same entity that takes responsibility for the clinical report. |
| Control | 0..0* |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | Analyzed by, Reported by |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 78. DiagnosticReport.specimen | |
| Definition | The Specimen resource of each Sample the report covers. A per-sample report references exactly one; a combined report references one for each Sample it covers, so the list has the same number of entries as basedOn. Each referenced Specimen carries its own Sample ID and Client Sample ID, so reading the Specimens is how the identifiers on a combined report are paired. The list is unordered. _include=DiagnosticReport:specimen is not supported in this version: read each Specimen by id. Details about the specimens on which this diagnostic report is based. |
| Short | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined reportSpecimens this report is based on |
| 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. |
| Control | 10..* |
| Type | Reference(SenaiteSpecimen, Specimen) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to report information about the collected specimens on which the report is based. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. DiagnosticReport.specimen.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| 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. |
| Control | 10..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. DiagnosticReport.study | |
| Definition | One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. 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. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted. |
| Short | Reference to full details of an analysis associated with the diagnostic report |
| Comments | For laboratory-type studies like GenomeStudy, type resources will be used for tracking additional metadata and workflow aspects of complex studies. ImagingStudy and the media element are somewhat overlapping - typically, the list of image references in the media 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. |
| Control | 0..0* |
| Type | Reference(GenomicStudy, ImagingStudy) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. DiagnosticReport.supportingInfo | |
| Definition | This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. |
| Short | Additional information supporting the diagnostic report |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 89. DiagnosticReport.media | |
| Definition | A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
| Short | Key images or data associated with this report |
| Control | 0..0* |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Many diagnostic services include images or data in the report as part of their service. |
| Alternate Names | DICOM, Slides, Scans |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 93. DiagnosticReport.conclusion | |
| Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | Clinical conclusion (interpretation) of test results |
| Control | 0..01 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. |
| Alternate Names | Report |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 95. DiagnosticReport.conclusionCode | |
| Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | Codes for the clinical conclusion of test results |
| Control | 0..0* |
| Binding | For example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings|5.0.0 (example to http://hl7.org/fhir/ValueSet/clinical-findings|5.0.0)SNOMED CT Clinical Findings |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 97. DiagnosticReport.presentedForm | |
| Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
| Short | Entire report as issued |
| Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. |
| Control | 0..1* |
| Type | Attachment |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 99. DiagnosticReport.presentedForm.extension | |
| Definition | An Extension 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 managable, 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. |
| Short | ExtensionAdditional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.presentedForm.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 101. DiagnosticReport.presentedForm.contentType | |
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
| Short | Mime type of the content, with charset etc. |
| Control | 0..1 This element is affected by the following invariants: att-1 |
| Binding | The codes SHALL be taken from MimeTypeshttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0)BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Processors of the data need to be able to know how to interpret the data. |
| Fixed Value | |
| Example | General: text/plain; charset=UTF-8, image/png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 103. DiagnosticReport.presentedForm.data | |
| Definition | Populated when the DiagnosticReport is fetched directly by id. Absent when returned via a _summary=true polling response. Consumers must perform a direct read to retrieve the PDF. The actual data of the attachment - a sequence of bytes, base64 encoded. |
| Short | Base64-encoded PDF — present on direct read, absent under _summary=trueData inline, base64ed |
| Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
| Control | 0..1 This element is affected by the following invariants: att-1 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Requirements | The data needs to able to be transmitted inline. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 105. DiagnosticReport.presentedForm.url | |
| Definition | A location where the data can be accessed. |
| Short | Uri where the data can be found |
| Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. |
| Control | 0..01 |
| Type | url |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | The data needs to be transmitted by reference. |
| Example | General: http://www.acme.com/logo-small.png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 107. DiagnosticReport.presentedForm.size | |
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
| Short | Number of bytes of content (if url provided) |
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
| Control | 0..01 |
| Type | integer64 |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 109. DiagnosticReport.presentedForm.hash | |
| Definition | The calculated hash of the data using SHA-1. Represented using base64. |
| Short | Hash of the data (sha-1, base64ed) |
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. |
| Control | 0..01 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
See the documentation on how to interpret the contents of this table
| 0. DiagnosticReport | |
| Invariants | dr-identifier-shape: A per-sample report (at most one basedOn) carries at most one Sample ID, at most one Client Sample ID and no Sample Group ID; a combined report (more than one basedOn) carries one Sample ID per basedOn, at most one Client Sample ID per basedOn, and exactly one Sample Group ID ((basedOn.count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-id').count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/client-sample-id').count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-group-id').empty()) or (basedOn.count() > 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-id').count() = basedOn.count() and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/client-sample-id').count() <= basedOn.count() and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-group-id').count() = 1))dr-specimen-count: A per-sample report references exactly one Specimen; a combined report references one Specimen for each ServiceRequest in basedOn ( specimen.count() = iif(basedOn.count() > 1, basedOn.count(), 1)) |
| 2. DiagnosticReport.extension | |
| Control | 0..0 |
| 4. DiagnosticReport.modifierExtension | |
| Control | 0..0 |
| 6. DiagnosticReport.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| 8. DiagnosticReport.identifier.extension | |
| Control | 0..0 |
| 10. DiagnosticReport.identifier.type | |
| Control | 0..0 |
| 12. DiagnosticReport.identifier.system | |
| Control | 1..? |
| 14. DiagnosticReport.identifier.value | |
| Control | 1..? |
| 16. DiagnosticReport.identifier.period | |
| Control | 0..0 |
| 18. DiagnosticReport.identifier.assigner | |
| Control | 0..0 |
| 20. DiagnosticReport.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The SENAITE sample Object ID, assigned by the server on creation and shared with the corresponding Specimen. A per-sample report carries one. A combined report carries one for each Sample it covers, each matching that Sample's Specimen, so a consumer can find a combined report by searching on any covered Sample ID. |
| Short | SENAITE-assigned sample ID — matches the Specimen usual identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| 22. DiagnosticReport.identifier:senaiteId.use | |
| Fixed Value | |
| 24. DiagnosticReport.identifier:senaiteId.system | |
| Fixed Value | |
| 26. DiagnosticReport.identifier:senaiteId.value | |
| Short | SENAITE-assigned sample identifier — alphanumeric and hyphens only |
| 28. DiagnosticReport.identifier:clientSampleId | |
| Slice Name | clientSampleId |
| Definition | The Client Sample ID — the consumer-owned identifier for the Sample (e.g. laboratory order number), if one was supplied on the Specimen entry of a POSTed SenaiteRequestBundle or entered against the Sample by laboratory staff. Holds the same value as the secondary identifier on the corresponding Specimen. Note that SenaiteServiceRequest carries no |
| Short | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| 30. DiagnosticReport.identifier:clientSampleId.use | |
| Fixed Value | |
| 32. DiagnosticReport.identifier:clientSampleId.system | |
| Fixed Value | |
| 34. DiagnosticReport.identifier:clientSampleId.value | |
| Short | External ID — alphanumeric and hyphens only |
| 36. DiagnosticReport.identifier:sampleGroupId | |
| Slice Name | sampleGroupId |
| Definition | The Sample Group ID: the consumer-owned value supplied as ServiceRequest.requisition, shared by the requests whose Samples a combined report covers. Present on a combined report (exactly one) and absent from a per-sample report. The value is unique within the consumer, and the server scopes searches on it to the caller's Client(s). Searchable as DiagnosticReport?identifier=https://fhir.senaite.org/NamingSystem/sample-group-id|<value>, which returns the combined report(s) for that group. |
| Short | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| 38. DiagnosticReport.identifier:sampleGroupId.use | |
| Control | 0..0 |
| 40. DiagnosticReport.identifier:sampleGroupId.system | |
| Fixed Value | |
| 42. DiagnosticReport.identifier:sampleGroupId.value | |
| Short | Sample Group ID — alphanumeric and hyphens only |
| 44. DiagnosticReport.basedOn | |
| Definition | A per-sample report has at most one ServiceRequest. A combined report lists every ServiceRequest whose Sample it covers; the list is fixed when the combined report is published. More than one entry marks a combined report. |
| Short | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report |
| 46. DiagnosticReport.basedOn.extension | |
| Control | 0..0 |
| 48. DiagnosticReport.basedOn.reference | |
| Control | 1..? |
| 50. DiagnosticReport.basedOn.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 52. DiagnosticReport.basedOn.display | |
| Control | 0..0 |
| 54. DiagnosticReport.status | |
| Definition | The status of the diagnostic report. Accepts: registered | partial | preliminary | final | entered-in-error |
| 56. DiagnosticReport.category | |
| Control | 0..0 |
| 58. DiagnosticReport.code | |
| 60. DiagnosticReport.code.extension | |
| Control | 0..0 |
| 62. DiagnosticReport.code.coding | |
| 64. DiagnosticReport.code.coding.extension | |
| Control | 0..0 |
| 66. DiagnosticReport.code.coding.system | |
| Binding | The codes SHOULD be taken from http://loinc.org (preferred to http://loinc.org) |
| 68. DiagnosticReport.code.coding.version | |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| 70. DiagnosticReport.code.coding.userSelected | |
| Control | 0..0 |
| 72. DiagnosticReport.subject | |
| 74. DiagnosticReport.subject.extension | |
| Control | 0..0 |
| 76. DiagnosticReport.subject.type | |
| Fixed Value | |
| 78. DiagnosticReport.subject.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 80. DiagnosticReport.encounter | |
| Control | 0..0 |
| 82. DiagnosticReport.effective[x] | |
| Control | 0..0 |
| 84. DiagnosticReport.issued | |
| Control | 0..0 |
| 86. DiagnosticReport.performer | |
| Control | 0..0 |
| 88. DiagnosticReport.resultsInterpreter | |
| Control | 0..0 |
| 90. DiagnosticReport.specimen | |
| Definition | The Specimen resource of each Sample the report covers. A per-sample report references exactly one; a combined report references one for each Sample it covers, so the list has the same number of entries as basedOn. Each referenced Specimen carries its own Sample ID and Client Sample ID, so reading the Specimens is how the identifiers on a combined report are paired. The list is unordered. _include=DiagnosticReport:specimen is not supported in this version: read each Specimen by id. |
| Short | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report |
| Control | 1..? |
| Type | Reference(SenaiteSpecimen) |
| 92. DiagnosticReport.specimen.reference | |
| Control | 1..? |
| 94. DiagnosticReport.result | |
| 96. DiagnosticReport.result.id | |
| Control | 0..0 |
| 98. DiagnosticReport.result.extension | |
| Control | 0..0 |
| 100. DiagnosticReport.result.reference | |
| Control | 1..? |
| 102. DiagnosticReport.result.type | |
| Control | 0..0 |
| 104. DiagnosticReport.result.identifier | |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 |
| 106. DiagnosticReport.study | |
| Control | 0..0 |
| 108. DiagnosticReport.supportingInfo | |
| Control | 0..0 |
| 110. DiagnosticReport.media | |
| Control | 0..0 |
| 112. DiagnosticReport.conclusion | |
| Control | 0..0 |
| 114. DiagnosticReport.conclusionCode | |
| Control | 0..0 |
| 116. DiagnosticReport.presentedForm | |
| Control | 0..1 |
| 118. DiagnosticReport.presentedForm.extension | |
| Control | 0..0 |
| 120. DiagnosticReport.presentedForm.contentType | |
| Fixed Value | |
| 122. DiagnosticReport.presentedForm.data | |
| Definition | Populated when the DiagnosticReport is fetched directly by id. Absent when returned via a _summary=true polling response. Consumers must perform a direct read to retrieve the PDF. |
| Short | Base64-encoded PDF — present on direct read, absent under _summary=true |
| 124. DiagnosticReport.presentedForm.url | |
| Control | 0..0 |
| 126. DiagnosticReport.presentedForm.size | |
| Control | 0..0 |
| 128. DiagnosticReport.presentedForm.hash | |
| Control | 0..0 |
See the documentation on how to interpret the contents of this table
| 0. DiagnosticReport | |
| Definition | The findings and interpretation of diagnostic tests performed on patients, groups of patients, products, substances, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports. The report also includes non-clinical context such as batch analysis and stability reporting of products and substances. |
| Short | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports |
| 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. |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | Report, Test, Result, Results, Labs, Laboratory |
| Invariants | dgr-1: When a Composition is referenced in `Diagnostic.composition`, all Observation resources referenced in `Composition.entry` must also be referenced in `Diagnostic.entry` or in the references Observations in `Observation.hasMember` (composition.exists() implies (composition.resolve().section.entry.reference.where(resolve() is Observation) in (result.reference|result.reference.resolve().hasMember.reference)))dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources ( contained.contained.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())dr-identifier-shape: A per-sample report (at most one basedOn) carries at most one Sample ID, at most one Client Sample ID and no Sample Group ID; a combined report (more than one basedOn) carries one Sample ID per basedOn, at most one Client Sample ID per basedOn, and exactly one Sample Group ID ( (basedOn.count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-id').count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/client-sample-id').count() <= 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-group-id').empty()) or (basedOn.count() > 1 and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-id').count() = basedOn.count() and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/client-sample-id').count() <= basedOn.count() and identifier.where(system = 'https://fhir.senaite.org/NamingSystem/sample-group-id').count() = 1))dr-specimen-count: A per-sample report references exactly one Specimen; a combined report references one Specimen for each ServiceRequest in basedOn ( specimen.count() = iif(basedOn.count() > 1, basedOn.count(), 1)) |
| 2. DiagnosticReport.id | |
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| Short | Logical id of this artifact |
| Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| Control | 0..1 |
| Type | id |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 4. DiagnosticReport.meta | |
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| Short | Metadata about the resource |
| Control | 0..1 |
| Type | Meta |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 6. DiagnosticReport.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| Short | A set of rules under which this content was created |
| 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 its narrative along with other profiles, value sets, etc. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. DiagnosticReport.language | |
| Definition | The base language in which the resource is written. |
| Short | Language of the resource content |
| 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). |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. DiagnosticReport.text | |
| Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| Short | Text summary of the resource, for human interpretation |
| Comments | Contained resources do not have a 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. |
| Control | 0..1 This element is affected by the following invariants: dom-6 |
| Type | Narrative |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | narrative, html, xhtml, display |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 12. DiagnosticReport.contained | |
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. |
| Short | Contained, inline 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. |
| Control | 0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5 |
| Type | Resource |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Alternate Names | inline resources, anonymous resources, contained resources |
| 14. DiagnosticReport.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. DiagnosticReport.modifierExtension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| Must Support | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. DiagnosticReport.identifier | |
| Definition | Identifiers assigned to this report by the performer or other systems. |
| Short | Business identifier for report |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier. The slices are Unordered and Closed, and can be differentiated using the following discriminators:
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| 20. DiagnosticReport.identifier.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 22. DiagnosticReport.identifier.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 24. DiagnosticReport.identifier.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 26. DiagnosticReport.identifier.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 28. DiagnosticReport.identifier.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 1..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 30. DiagnosticReport.identifier.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | The value that is unique |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 1..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 32. DiagnosticReport.identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..0 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 34. DiagnosticReport.identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..0 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 36. DiagnosticReport.identifier:senaiteId | |
| Slice Name | senaiteId |
| Definition | The SENAITE sample Object ID, assigned by the server on creation and shared with the corresponding Specimen. A per-sample report carries one. A combined report carries one for each Sample it covers, each matching that Sample's Specimen, so a consumer can find a combined report by searching on any covered Sample ID. |
| Short | SENAITE-assigned sample ID — matches the Specimen usual identifier |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 38. DiagnosticReport.identifier:senaiteId.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 40. DiagnosticReport.identifier:senaiteId.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 42. DiagnosticReport.identifier:senaiteId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. DiagnosticReport.identifier:senaiteId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. DiagnosticReport.identifier:senaiteId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 48. DiagnosticReport.identifier:senaiteId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | SENAITE-assigned sample identifier — alphanumeric and hyphens only |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 50. DiagnosticReport.identifier:senaiteId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 52. DiagnosticReport.identifier:senaiteId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 54. DiagnosticReport.identifier:clientSampleId | |
| Slice Name | clientSampleId |
| Definition | The Client Sample ID — the consumer-owned identifier for the Sample (e.g. laboratory order number), if one was supplied on the Specimen entry of a POSTed SenaiteRequestBundle or entered against the Sample by laboratory staff. Holds the same value as the secondary identifier on the corresponding Specimen. Note that SenaiteServiceRequest carries no |
| Short | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..* |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 56. DiagnosticReport.identifier:clientSampleId.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 58. DiagnosticReport.identifier:clientSampleId.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 60. DiagnosticReport.identifier:clientSampleId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 62. DiagnosticReport.identifier:clientSampleId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 64. DiagnosticReport.identifier:clientSampleId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 66. DiagnosticReport.identifier:clientSampleId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | External ID — alphanumeric and hyphens only |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 68. DiagnosticReport.identifier:clientSampleId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 70. DiagnosticReport.identifier:clientSampleId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 72. DiagnosticReport.identifier:sampleGroupId | |
| Slice Name | sampleGroupId |
| Definition | The Sample Group ID: the consumer-owned value supplied as ServiceRequest.requisition, shared by the requests whose Samples a combined report covers. Present on a combined report (exactly one) and absent from a per-sample report. The value is unique within the consumer, and the server scopes searches on it to the caller's Client(s). Searchable as DiagnosticReport?identifier=https://fhir.senaite.org/NamingSystem/sample-group-id|<value>, which returns the combined report(s) for that group. |
| Short | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers |
| Comments | Usually assigned by the Information System of the diagnostic service provider (filler id). |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 |
| Type | Identifier |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | ReportID, Filler ID, Placer ID |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. DiagnosticReport.identifier:sampleGroupId.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 76. DiagnosticReport.identifier:sampleGroupId.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.identifier.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 78. DiagnosticReport.identifier:sampleGroupId.use | |
| Definition | The purpose of this identifier. |
| Short | usual | official | temp | secondary | old (If known) |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Control | 0..0 |
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)Identifies the purpose for this identifier, if known . |
| Type | code |
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 80. DiagnosticReport.identifier:sampleGroupId.type | |
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| Short | Description of identifier |
| 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. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from IdentifierTypeCodes (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| Type | CodeableConcept |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 82. DiagnosticReport.identifier:sampleGroupId.system | |
| Definition | Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique. |
| Short | The namespace for the identifier value |
| Comments | Identifier.system is always case sensitive. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Fixed Value | |
| Example | General: http://www.acme.com/identifiers/patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 84. DiagnosticReport.identifier:sampleGroupId.value | |
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| Short | Sample Group ID — alphanumeric and hyphens only |
| 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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. |
| Control | 0..1 This element is affected by the following invariants: ident-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Example | General: 123456 |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 86. DiagnosticReport.identifier:sampleGroupId.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Short | Time period when id is/was valid for use |
| Control | 0..1 |
| Type | Period |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 88. DiagnosticReport.identifier:sampleGroupId.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Short | Organization that issued id (may be just text) |
| 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. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 90. DiagnosticReport.basedOn | |
| Definition | A per-sample report has at most one ServiceRequest. A combined report lists every ServiceRequest whose Sample it covers; the list is fixed when the combined report is published. More than one entry marks a combined report. |
| Short | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report |
| 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. |
| Control | 0..* |
| Type | Reference(CarePlan, ImmunizationRecommendation, MedicationRequest, NutritionOrder, ServiceRequest) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. |
| Alternate Names | Request |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 92. DiagnosticReport.basedOn.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 94. DiagnosticReport.basedOn.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.basedOn.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 96. DiagnosticReport.basedOn.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 98. DiagnosticReport.basedOn.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 100. DiagnosticReport.basedOn.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| 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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 102. DiagnosticReport.basedOn.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| 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. |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 104. DiagnosticReport.status | |
| Definition | The status of the diagnostic report. Accepts: registered | partial | preliminary | final | entered-in-error |
| Short | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown |
| Control | 1..1 |
| Binding | The codes SHALL be taken from DiagnosticReportStatus (required to http://hl7.org/fhir/ValueSet/diagnostic-report-status|5.0.0)The status of the diagnostic report. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 106. DiagnosticReport.category | |
| Definition | A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes. |
| Short | Service category |
| Comments | Multiple categories are allowed using various categorization schemes. The level of granularity is defined by the category concepts in the value set. More fine-grained filtering can be performed using the metadata and/or terminology hierarchy in DiagnosticReport.code. |
| Control | 0..0 |
| Binding | For example codes, see DiagnosticServiceSectionCodes (example to http://hl7.org/fhir/ValueSet/diagnostic-service-sections|5.0.0)HL7 V2 table 0074 |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | Department, Sub-department, Service, Discipline |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 108. DiagnosticReport.code | |
| Definition | A code or name that describes this diagnostic report. |
| Short | Name/Code for this diagnostic report |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from LOINCDiagnosticReportCodes (preferred to http://hl7.org/fhir/ValueSet/report-codes|5.0.0)LOINC Codes for Diagnostic Reports |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Alternate Names | Type |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 110. DiagnosticReport.code.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 112. DiagnosticReport.code.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.code.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 114. DiagnosticReport.code.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Short | Code defined by a terminology system |
| 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. |
| Control | 0..* |
| Type | Coding |
| Is Modifier | false |
| Summary | true |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 116. DiagnosticReport.code.coding.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 118. DiagnosticReport.code.coding.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.code.coding.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 120. DiagnosticReport.code.coding.system | |
| Definition | The identification of the code system that defines the meaning of the symbol in the code. |
| Short | Identity of the terminology system |
| 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 be an absolute reference to some definition that establishes the system clearly and unambiguously. |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from http://loinc.org (preferred to http://loinc.org) |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to be unambiguous about the source of the definition of the symbol. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 122. DiagnosticReport.code.coding.version | |
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
| Short | Version of the system - if relevant |
| 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. |
| Note | This is a business version Id, not a resource version Id (see discussion) |
| Control | 0..0 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 124. DiagnosticReport.code.coding.code | |
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
| Short | Symbol in syntax defined by the system |
| Control | 0..1 This element is affected by the following invariants: cod-1 |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to refer to a particular code in the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 126. DiagnosticReport.code.coding.display | |
| Definition | A representation of the meaning of the code in the system, following the rules of the system. |
| Short | Representation defined by the system |
| Control | 0..1 This element is affected by the following invariants: cod-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 128. DiagnosticReport.code.coding.userSelected | |
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
| Short | If this coding was chosen directly by the user |
| 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. |
| Control | 0..0 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 130. DiagnosticReport.code.text | |
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
| Short | Plain text representation of the concept |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 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. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 132. DiagnosticReport.subject | |
| Definition | The subject of the report. Usually, but not always, this is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources. |
| Short | The subject of the report - usually, but not always, the patient |
| Control | 0..1 |
| Type | Reference(Patient, Group, Device, Location, Organization, Practitioner, Medication, Substance, BiologicallyDerivedProduct) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | SHALL know the subject context. |
| Alternate Names | Patient |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 134. DiagnosticReport.subject.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 136. DiagnosticReport.subject.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.subject.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 138. DiagnosticReport.subject.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| 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. |
| Control | 0..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 140. DiagnosticReport.subject.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Fixed Value | |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 142. DiagnosticReport.subject.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| 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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 144. DiagnosticReport.subject.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| 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. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 146. DiagnosticReport.encounter | |
| Definition | The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. |
| Short | Health care event when test ordered |
| 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). |
| Control | 0..0 |
| Type | Reference(Encounter) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Links the request to the Encounter context. |
| Alternate Names | Context |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 148. DiagnosticReport.effective[x] | |
| Definition | The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself. |
| Short | Clinically relevant time/time-period for 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. |
| Control | 0..0 |
| Type | Choice of: dateTime, Period |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Need to know where in the patient history to file/present this report. |
| Alternate Names | Observation time, Effective Time, Occurrence |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 150. DiagnosticReport.issued | |
| Definition | The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
| Short | DateTime this version was made |
| 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. |
| Control | 0..0 |
| Type | instant |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | true |
| Requirements | Clinicians need to be able to check the date that the report was released. |
| Alternate Names | Date published, Date Issued, Date Verified |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 152. DiagnosticReport.performer | |
| Definition | The diagnostic service that is responsible for issuing the report. |
| Short | Responsible Diagnostic Service |
| Comments | This is not necessarily the source of the atomic data items or the entity that interpreted the results. It is the entity that takes responsibility for the clinical report. |
| Control | 0..0 |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | Laboratory, Service, Practitioner, Department, Company, Authorized by, Director |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 154. DiagnosticReport.resultsInterpreter | |
| Definition | The practitioner or organization that is responsible for the report's conclusions and interpretations. |
| Short | Primary result interpreter |
| Comments | Might not be the same entity that takes responsibility for the clinical report. |
| Control | 0..0 |
| Type | Reference(Practitioner, PractitionerRole, Organization, CareTeam) |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| 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. |
| Alternate Names | Analyzed by, Reported by |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 156. DiagnosticReport.specimen | |
| Definition | The Specimen resource of each Sample the report covers. A per-sample report references exactly one; a combined report references one for each Sample it covers, so the list has the same number of entries as basedOn. Each referenced Specimen carries its own Sample ID and Client Sample ID, so reading the Specimens is how the identifiers on a combined report are paired. The list is unordered. _include=DiagnosticReport:specimen is not supported in this version: read each Specimen by id. |
| Short | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report |
| 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. |
| Control | 1..* |
| Type | Reference(SenaiteSpecimen) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to report information about the collected specimens on which the report is based. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 158. DiagnosticReport.specimen.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 160. DiagnosticReport.specimen.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.specimen.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 162. DiagnosticReport.specimen.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 164. DiagnosticReport.specimen.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 known RESTful URL) or by resolving the target of the reference. |
| Control | 0..1 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 166. DiagnosticReport.specimen.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| 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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 168. DiagnosticReport.specimen.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| 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. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 170. DiagnosticReport.result | |
| Definition | Observations that are part of this diagnostic report. |
| Short | Observations |
| Comments | Observations can contain observations. |
| Control | 0..* This element is affected by the following invariants: dgr-1 |
| Type | Reference(Observation) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. |
| Alternate Names | Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 172. DiagnosticReport.result.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..0 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 174. DiagnosticReport.result.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.result.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 176. DiagnosticReport.result.reference | |
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
| Short | Literal reference, Relative, internal or absolute URL |
| 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. |
| Control | 1..1 This element is affected by the following invariants: ref-2, ref-1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 178. DiagnosticReport.result.type | |
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
| Short | Type the reference refers to (e.g. "Patient") - must be a resource in resources |
| 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 known RESTful URL) or by resolving the target of the reference. |
| Control | 0..0 |
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)Aa resource (or, for logical models, the URI of the logical model). |
| Type | uri |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 180. DiagnosticReport.result.identifier | |
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
| Short | Logical reference, when literal reference is not known |
| 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). This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 0..0 This element is affected by the following invariants: ref-2 |
| Type | Identifier |
| Is Modifier | false |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 182. DiagnosticReport.result.display | |
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
| Short | Text alternative for the resource |
| 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. |
| Control | 0..1 This element is affected by the following invariants: ref-2 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 184. DiagnosticReport.note | |
| Definition | Comments about the diagnostic report. |
| Short | Comments about the diagnostic report |
| Comments | 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. |
| Control | 0..* |
| Type | Annotation |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to provide free text additional information. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 186. DiagnosticReport.study | |
| Definition | One or more links to full details of any study performed during the diagnostic investigation. An ImagingStudy might comprise a set of radiologic images obtained via a procedure that are analyzed as a group. 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. A GenomicStudy might comprise one or more analyses, each serving a specific purpose. These analyses may vary in method (e.g., karyotyping, CNV, or SNV detection), performer, software, devices used, or regions targeted. |
| Short | Reference to full details of an analysis associated with the diagnostic report |
| Comments | For laboratory-type studies like GenomeStudy, type resources will be used for tracking additional metadata and workflow aspects of complex studies. ImagingStudy and the media element are somewhat overlapping - typically, the list of image references in the media 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. |
| Control | 0..0 |
| Type | Reference(GenomicStudy, ImagingStudy) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 188. DiagnosticReport.supportingInfo | |
| Definition | This backbone element contains supporting information that was used in the creation of the report not included in the results already included in the report. |
| Short | Additional information supporting the diagnostic report |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 195. DiagnosticReport.media | |
| Definition | A list of key images or data associated with this report. The images or data are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest). |
| Short | Key images or data associated with this report |
| Control | 0..0 |
| Type | BackboneElement |
| Is Modifier | false |
| Must Support | false |
| Summary | true |
| Requirements | Many diagnostic services include images or data in the report as part of their service. |
| Alternate Names | DICOM, Slides, Scans |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 202. DiagnosticReport.composition | |
| Definition | Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. |
| Short | Reference to a Composition resource for the DiagnosticReport structure |
| Comments | 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. |
| Control | 0..1 This element is affected by the following invariants: dgr-1 |
| Type | Reference(Composition) |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 204. DiagnosticReport.conclusion | |
| Definition | Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | Clinical conclusion (interpretation) of test results |
| Control | 0..0 |
| Type | markdown |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| Summary | false |
| Requirements | Need to be able to provide a conclusion that is not lost among the basic result data. |
| Alternate Names | Report |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 206. DiagnosticReport.conclusionCode | |
| Definition | One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. |
| Short | Codes for the clinical conclusion of test results |
| Control | 0..0 |
| Binding | For example codes, see SNOMEDCTClinicalFindings (example to http://hl7.org/fhir/ValueSet/clinical-findings|5.0.0)SNOMED CT Clinical Findings |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 208. DiagnosticReport.presentedForm | |
| Definition | Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. |
| Short | Entire report as issued |
| Comments | "application/pdf" is recommended as the most reliable and interoperable in this context. |
| Control | 0..1 |
| Type | Attachment |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Requirements | Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 210. DiagnosticReport.presentedForm.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 212. DiagnosticReport.presentedForm.extension | |
| Definition | An Extension |
| Short | Extension |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on DiagnosticReport.presentedForm.extension. The slices are Unordered and Open, and can be differentiated using the following discriminators:
|
| 214. DiagnosticReport.presentedForm.contentType | |
| Definition | Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate. |
| Short | Mime type of the content, with charset etc. |
| Control | 0..1 This element is affected by the following invariants: att-1 |
| Binding | The codes SHALL be taken from MimeTypes (required to http://hl7.org/fhir/ValueSet/mimetypes|5.0.0)BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Processors of the data need to be able to know how to interpret the data. |
| Fixed Value | |
| Example | General: text/plain; charset=UTF-8, image/png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 216. DiagnosticReport.presentedForm.language | |
| Definition | The human language of the content. The value can be any valid value according to BCP 47. |
| Short | Human language of the content (BCP-47) |
| Control | 0..1 |
| Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)IETF language tag for a human language. |
| Type | code |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Users need to be able to choose between the languages in a set of attachments. |
| Example | General: en-AU |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 218. DiagnosticReport.presentedForm.data | |
| Definition | Populated when the DiagnosticReport is fetched directly by id. Absent when returned via a _summary=true polling response. Consumers must perform a direct read to retrieve the PDF. |
| Short | Base64-encoded PDF — present on direct read, absent under _summary=true |
| Comments | The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. |
| Control | 0..1 This element is affected by the following invariants: att-1 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Requirements | The data needs to able to be transmitted inline. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 220. DiagnosticReport.presentedForm.url | |
| Definition | A location where the data can be accessed. |
| Short | Uri where the data can be found |
| Comments | If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data. |
| Control | 0..0 |
| Type | url |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | The data needs to be transmitted by reference. |
| Example | General: http://www.acme.com/logo-small.png |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 222. DiagnosticReport.presentedForm.size | |
| Definition | The number of bytes of data that make up this attachment (before base64 encoding, if that is done). |
| Short | Number of bytes of content (if url provided) |
| Comments | The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference. |
| Control | 0..0 |
| Type | integer64 |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 224. DiagnosticReport.presentedForm.hash | |
| Definition | The calculated hash of the data using SHA-1. Represented using base64. |
| Short | Hash of the data (sha-1, base64ed) |
| Comments | The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature. |
| Control | 0..0 |
| Type | base64Binary |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version). |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 226. DiagnosticReport.presentedForm.title | |
| Definition | A label or set of text to display in place of the data. |
| Short | Label to display in place of the data |
| Comments | May sometimes be derived from the source filename. |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer. |
| Example | General: Official Corporate Logo |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 228. DiagnosticReport.presentedForm.creation | |
| Definition | The date that the attachment was first created. |
| Short | Date attachment was first created |
| Control | 0..1 |
| Type | dateTime |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Requirements | This is often tracked as an integrity issue for use of the attachment. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 230. DiagnosticReport.presentedForm.height | |
| Definition | Height of the image in pixels (photo/video). |
| Short | Height of the image in pixels (photo/video) |
| Control | 0..1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 232. DiagnosticReport.presentedForm.width | |
| Definition | Width of the image in pixels (photo/video). |
| Short | Width of the image in pixels (photo/video) |
| Control | 0..1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 234. DiagnosticReport.presentedForm.frames | |
| Definition | The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required. |
| Short | Number of frames if > 1 (photo) |
| Comments | if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated. |
| Control | 0..1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 236. DiagnosticReport.presentedForm.duration | |
| Definition | The duration of the recording in seconds - for audio and video. |
| Short | Length in seconds (audio / video) |
| Comments | The duration might differ from occurrencePeriod if recording was paused. |
| Control | 0..1 |
| Type | decimal |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 238. DiagnosticReport.presentedForm.pages | |
| Definition | The number of pages when printed. |
| Short | Number of printed pages |
| Control | 0..1 |
| Type | positiveInt |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |