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
| Official URL: https://fhir.senaite.org/StructureDefinition/SenaiteDiagnosticReport | Version: 0.1.0 | |||
| Draft as of 2026-11-05 | Computable Name: SenaiteDiagnosticReport | |||
This is the results for the lab test requested by the ServiceRequest - as such it carries a basedOn link to the Service Request (or, for a combined report, to each of them). It may contain either the pdf file in presentedForm or the quantitative results as Observations in results.
Two kinds of report. A SenaiteDiagnosticReport is one of:
basedOn has at most one ServiceRequest (none when the Sample was created
inside SENAITE rather than from a SenaiteRequestBundle), it carries the Sample ID and Client Sample ID
identifiers, and its presentedForm is that Sample's PDF.ServiceRequest.requisition. basedOn lists every ServiceRequest it
covers (more than one), result lists the Observations of all of them, presentedForm is the single
combined PDF, and code is the default panel code 30954-2 because several panels are covered. It carries
one Sample ID for each Sample it covers, a Client Sample ID for each Sample that has one, and the Sample Group ID (the requisition value) as identifiers. These lists are unordered and carry no pairing; to pair a Client Sample ID with its Sample ID read the referenced Specimens or use the per-sample report.basedOn.count() > 1 is the marker for a combined report. A combined report over a single Sample is not
a combined report: it is a per-sample report.
Specimen. specimen references the Specimen of each Sample the report covers: exactly one on a per-sample report, and one for each covered Sample on a combined report (as many as basedOn). It makes a report self-describing without matching identifiers or dereferencing ServiceRequests. 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, like the other lists. _include=DiagnosticReport:specimen is not supported in this version: read each Specimen by id.
Coexistence. Both kinds can exist for the same Sample at the same time. Publishing or republishing a
combined report never removes or replaces a per-sample report, so a search can return both: searching by a Sample ID returns that Sample's per-sample report and any combined report covering it. Consumers
should ingest per-sample reports as the results and treat a combined report as a document. Each
Observation's own basedOn identifies the ServiceRequest it belongs to, so the Observations of a combined
report can always be split by sample.
Combined report lifecycle. A combined report is only created once every Sample it covers is final, so
its status is final at creation. Its membership (basedOn) is fixed when it is published; it is not
re-evaluated if more samples later join the requisition. A correction or a late sample is delivered as a
new combined report, and the superseded one is marked entered-in-error. The combined PDF is a snapshot:
after a correction to a constituent Sample it can disagree with the live Observations until it is
republished. A combined report never spans different Clients or Patients.
See Combined reports and Identifiers.
Polling behaviour and _summary=true
When consumers poll for new results via the search endpoint, _summary=true is required. Under this mode the FHIR server returns only the summary elements of the DiagnosticReport as defined by the base specification. Critically, presentedForm.data (the base64-encoded PDF payload) is not a summary element and will be absent from search results — only metadata such as presentedForm.contentType and presentedForm.title is returned.
To retrieve the full PDF, consumers must perform a direct read of the specific DiagnosticReport by id:
GET {fhir_api_root}/DiagnosticReport/{id}
This two-step pattern — poll with _summary=true to discover new reports, then fetch by id for the PDF — is intentional and keeps polling responses lightweight.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1, dr-identifier-shape, dr-specimen-count |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Identifier | Business identifier for report Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
0..* | Identifier | SENAITE-assigned sample ID — matches the Specimen usual identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | SENAITE-assigned sample identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() |
0..* | Identifier | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | External ID — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | Sample Group ID — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
![]() ![]() |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): LOINC Codes for Diagnostic Reports | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
1..* | Reference(SenaiteSpecimen) | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report | |
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
0..1 | Attachment | Entire report as issued | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Fixed Value: application/pdf (no extensions allowed) |
![]() ![]() ![]() |
C | 0..1 | base64Binary | Base64-encoded PDF — present on direct read, absent under _summary=true |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:clientSampleId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.5 |
| DiagnosticReport.presentedForm.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | 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 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | error | DiagnosticReport | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| dr-identifier-shape | error | DiagnosticReport | 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 | error | DiagnosticReport | 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)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dr-identifier-shape, dr-specimen-count | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..* | Identifier | Business identifier for report Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..* | Identifier | SENAITE-assigned sample ID — matches the Specimen usual identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | SENAITE-assigned sample identifier — alphanumeric and hyphens only | |
![]() ![]() ![]() |
0..* | Identifier | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | External ID — alphanumeric and hyphens only | |
![]() ![]() ![]() |
0..1 | Identifier | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | Sample Group ID — alphanumeric and hyphens only | |
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown | |
![]() ![]() |
0..0 | Service category | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Binding: http://loinc.org (preferred) | |
![]() ![]() ![]() ![]() |
0..0 | Version of the system - if relevant | ||
![]() ![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Fixed Value: Patient (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() |
0..0 | Health care event when test ordered | ||
![]() ![]() |
0..0 | Clinically relevant time/time-period for report | ||
![]() ![]() |
0..0 | DateTime this version was made | ||
![]() ![]() |
0..0 | Responsible Diagnostic Service | ||
![]() ![]() |
0..0 | Primary result interpreter | ||
![]() ![]() |
1..* | Reference(SenaiteSpecimen) | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report | |
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") - must be a resource in resources | ||
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() |
0..0 | Reference to full details of an analysis associated with the diagnostic report | ||
![]() ![]() |
0..0 | Additional information supporting the diagnostic report | ||
![]() ![]() |
0..0 | Key images or data associated with this report | ||
![]() ![]() |
0..0 | Clinical conclusion (interpretation) of test results | ||
![]() ![]() |
0..0 | Codes for the clinical conclusion of test results | ||
![]() ![]() |
0..1 | Attachment | Entire report as issued | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/pdf (no extensions allowed) | |
![]() ![]() ![]() |
0..1 | base64Binary | Base64-encoded PDF — present on direct read, absent under _summary=true | |
![]() ![]() ![]() |
0..0 | Uri where the data can be found | ||
![]() ![]() ![]() |
0..0 | Number of bytes of content (if url provided) | ||
![]() ![]() ![]() |
0..0 | Hash of the data (sha-1, base64ed) | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.code.coding.system | Base | preferred | http://loinc.org | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dr-identifier-shape | error | DiagnosticReport | 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 | error | DiagnosticReport | 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)
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1, dr-identifier-shape, dr-specimen-count | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Identifier | Business identifier for report Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
0..* | Identifier | SENAITE-assigned sample ID — matches the Specimen usual identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | SENAITE-assigned sample identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..* | Identifier | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | External ID — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Sample Group ID — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |||||
![]() ![]() |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): LOINC Codes for Diagnostic Reports | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Binding: http://loinc.org (preferred) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
0..1 | Reference(Patient | Group | Device | Location | Organization | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | The subject of the report - usually, but not always, the patient | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Patient (no extensions allowed) | |||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
1..* | Reference(SenaiteSpecimen) | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
C | 0..* | Reference(Observation) | Observations | ||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Annotation | Comments about the diagnostic report | |||||
![]() ![]() |
C | 0..1 | Reference(Composition) | Reference to a Composition resource for the DiagnosticReport structure | ||||
![]() ![]() |
0..1 | Attachment | Entire report as issued | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Fixed Value: application/pdf (no extensions allowed) | ||||
![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | |||||
![]() ![]() ![]() |
C | 0..1 | base64Binary | Base64-encoded PDF — present on direct read, absent under _summary=true | ||||
![]() ![]() ![]() |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:senaiteId.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:clientSampleId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:clientSampleId.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:sampleGroupId.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.basedOn.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code.coding.system | Base | preferred | http://loinc.org | Not State | Unknown |
| DiagnosticReport.subject.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.specimen.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.5 |
| DiagnosticReport.presentedForm.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.presentedForm.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | 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 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | error | DiagnosticReport | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| dr-identifier-shape | error | DiagnosticReport | 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 | error | DiagnosticReport | 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)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DiagnosticReport
Summary
Mandatory: 2 elements(4 nested mandatory elements)
Fixed: 7 elements
Prohibited: 35 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1, dr-identifier-shape, dr-specimen-count |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Identifier | Business identifier for report Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
0..* | Identifier | SENAITE-assigned sample ID — matches the Specimen usual identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | SENAITE-assigned sample identifier — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() |
0..* | Identifier | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | External ID — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() ![]() |
0..1 | Identifier | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 0..1 | string | Sample Group ID — alphanumeric and hyphens only Example General: 123456 |
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |
![]() ![]() |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): LOINC Codes for Diagnostic Reports | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
1..* | Reference(SenaiteSpecimen) | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report | |
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() |
0..1 | Attachment | Entire report as issued | |
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() |
C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Fixed Value: application/pdf (no extensions allowed) |
![]() ![]() ![]() |
C | 0..1 | base64Binary | Base64-encoded PDF — present on direct read, absent under _summary=true |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:clientSampleId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.5 |
| DiagnosticReport.presentedForm.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | 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 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | error | DiagnosticReport | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| dr-identifier-shape | error | DiagnosticReport | 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 | error | DiagnosticReport | 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)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from DiagnosticReport
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dr-identifier-shape, dr-specimen-count | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
0..* | Identifier | Business identifier for report Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..0 | Description of identifier | ||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() ![]() |
0..0 | Time period when id is/was valid for use | ||
![]() ![]() ![]() ![]() |
0..0 | Organization that issued id (may be just text) | ||
![]() ![]() ![]() |
0..* | Identifier | SENAITE-assigned sample ID — matches the Specimen usual identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: usual (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | SENAITE-assigned sample identifier — alphanumeric and hyphens only | |
![]() ![]() ![]() |
0..* | Identifier | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Fixed Value: secondary (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | External ID — alphanumeric and hyphens only | |
![]() ![]() ![]() |
0..1 | Identifier | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers | |
![]() ![]() ![]() ![]() |
0..0 | usual | official | temp | secondary | old (If known) | ||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |
![]() ![]() ![]() ![]() |
0..1 | string | Sample Group ID — alphanumeric and hyphens only | |
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() ![]() |
0..0 | Text alternative for the resource | ||
![]() ![]() |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown | |
![]() ![]() |
0..0 | Service category | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Binding: http://loinc.org (preferred) | |
![]() ![]() ![]() ![]() |
0..0 | Version of the system - if relevant | ||
![]() ![]() ![]() ![]() |
0..0 | If this coding was chosen directly by the user | ||
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Fixed Value: Patient (no extensions allowed) | |
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() |
0..0 | Health care event when test ordered | ||
![]() ![]() |
0..0 | Clinically relevant time/time-period for report | ||
![]() ![]() |
0..0 | DateTime this version was made | ||
![]() ![]() |
0..0 | Responsible Diagnostic Service | ||
![]() ![]() |
0..0 | Primary result interpreter | ||
![]() ![]() |
1..* | Reference(SenaiteSpecimen) | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report | |
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() |
||||
![]() ![]() ![]() |
0..0 | Unique id for inter-element referencing | ||
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |
![]() ![]() ![]() |
0..0 | Type the reference refers to (e.g. "Patient") - must be a resource in resources | ||
![]() ![]() ![]() |
0..0 | Logical reference, when literal reference is not known | ||
![]() ![]() |
0..0 | Reference to full details of an analysis associated with the diagnostic report | ||
![]() ![]() |
0..0 | Additional information supporting the diagnostic report | ||
![]() ![]() |
0..0 | Key images or data associated with this report | ||
![]() ![]() |
0..0 | Clinical conclusion (interpretation) of test results | ||
![]() ![]() |
0..0 | Codes for the clinical conclusion of test results | ||
![]() ![]() |
0..1 | Attachment | Entire report as issued | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Fixed Value: application/pdf (no extensions allowed) | |
![]() ![]() ![]() |
0..1 | base64Binary | Base64-encoded PDF — present on direct read, absent under _summary=true | |
![]() ![]() ![]() |
0..0 | Uri where the data can be found | ||
![]() ![]() ![]() |
0..0 | Number of bytes of content (if url provided) | ||
![]() ![]() ![]() |
0..0 | Hash of the data (sha-1, base64ed) | ||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.code.coding.system | Base | preferred | http://loinc.org | Not State | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| dr-identifier-shape | error | DiagnosticReport | 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 | error | DiagnosticReport | 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)
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | DiagnosticReport | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Constraints: dgr-1, dr-identifier-shape, dr-specimen-count | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Identifier | Business identifier for report Slice: Unordered, Closed by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
0..* | Identifier | SENAITE-assigned sample ID — matches the Specimen usual identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: usual (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | SENAITE-assigned sample identifier — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..* | Identifier | Client Sample ID from the consumer's system — mirrors the Specimen secondary identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Fixed Value: secondary (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | External ID — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | Sample Group ID — the value of ServiceRequest.requisition, grouping the Samples a combined report covers | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.senaite.org/NamingSystem/sample-group-id (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Sample Group ID — alphanumeric and hyphens only Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..* | Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) | The ServiceRequest(s) this report is for — one for a per-sample report, several for a combined report | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() |
1..1 | code | registered | partial | preliminary | modified | final | amended | corrected | appended | cancelled | entered-in-error | unknown Binding: DiagnosticReportStatus (required): The status of the diagnostic report. | |||||
![]() ![]() |
1..1 | CodeableConcept | Name/Code for this diagnostic report Binding: LOINCDiagnosticReportCodes (preferred): LOINC Codes for Diagnostic Reports | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
0..* | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Binding: http://loinc.org (preferred) | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
0..1 | Reference(Patient | Group | Device | Location | Organization | Practitioner | Medication | Substance | BiologicallyDerivedProduct) | The subject of the report - usually, but not always, the patient | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Fixed Value: Patient (no extensions allowed) | |||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
1..* | Reference(SenaiteSpecimen) | The Specimen of each Sample this report covers — one for a per-sample report, one per covered Sample for a combined report | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() |
C | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
C | 0..* | Reference(Observation) | Observations | ||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
C | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Annotation | Comments about the diagnostic report | |||||
![]() ![]() |
C | 0..1 | Reference(Composition) | Reference to a Composition resource for the DiagnosticReport structure | ||||
![]() ![]() |
0..1 | Attachment | Entire report as issued | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() |
C | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Fixed Value: application/pdf (no extensions allowed) | ||||
![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | |||||
![]() ![]() ![]() |
C | 0..1 | base64Binary | Base64-encoded PDF — present on direct read, absent under _summary=true | ||||
![]() ![]() ![]() |
0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | |||||
![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DiagnosticReport.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:senaiteId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:senaiteId.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:clientSampleId.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:clientSampleId.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.identifier:sampleGroupId.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.basedOn.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.status | Base | required | Diagnostic Report Status | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code | Base | preferred | LOINC Diagnostic Report Codes | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.code.coding.system | Base | preferred | http://loinc.org | Not State | Unknown |
| DiagnosticReport.subject.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.specimen.type | Base | extensible | Resource Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.supportingInfo.type | Base | example | hl7VS-VS-observationType | 📦3.0.0 | THO v7.5 |
| DiagnosticReport.presentedForm.contentType | Base | required | Mime Types | 📍5.0.0 | FHIR Std. |
| DiagnosticReport.presentedForm.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dgr-1 | error | DiagnosticReport | 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 | error | DiagnosticReport | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DiagnosticReport | 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 | error | DiagnosticReport | 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 | error | DiagnosticReport | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DiagnosticReport | A resource should have narrative for robust management |
text.`div`.exists()
|
| dr-identifier-shape | error | DiagnosticReport | 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 | error | DiagnosticReport | 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)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DiagnosticReport
Summary
Mandatory: 2 elements(4 nested mandatory elements)
Fixed: 7 elements
Prohibited: 35 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron