RDC Interoperability Guide

DiagnosticReport

Rationale behind the usage of contained resources

In the context of providing support to management of documents in general, and AGP Report specifically, Data Architecture has proposed a model based on FHIR’s Diagnostic Report.

The particular scope of this use case, in which the CGM Values from the report are not stored in RDC's internal storage, implies that these Observations do not have an associated ID to refer to. In other words, they do not exist outside of the scope of the DiagnosticReport profile.

To cover this gap, it was agreed to use FHIR's contained-resources approach. This property enables a structure within the DiagnosticReport profile that allows to directly store Observations within it, with no internal ID required. With respect to implementation and reading of the final object, the contained property contains an array of CGM Observations.

Overview

Profile (Observation) is for providing additional context information in diagnostic domain such as Carbs, EWM etc.,

Below is the code that are currently used under this Observation: [Code to be updated]

System Code Display

http://roche.com/fhir/iop/cs AGP-Report AGP-Report

System	Code	Display
http://roche.com/fhir/iop/cs	AGP-Report	AGP-Report

Canonical url - http://roche.com/fhir/iop/StructureDefinition/DiagnosticReport

The below overview shows the elements of the resource, data type and the cardinality of each. Further details like "Binding"/"Fixed values"/"contraints" etc can be found on clicking on each element.

Structure definition :

DiagnosticReport	I		DiagnosticReport	There are no (further) constraints on this element Element id DiagnosticReport Short description A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports Alternate names Report, Test, Result, Results, Labs, Laboratory 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. 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. Data type DiagnosticReport Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` 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))` Mappings rim: n/a rim: Entity. Role, or Act rim: Entity, Role, or Act workflow: Event w5: clinical.diagnostics v2: ORU -> OBR rim: Observation[classCode=OBS, moodCode=EVN]
id	Σ	0..1	id	There are no (further) constraints on this element Element id DiagnosticReport.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. 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. Data type id
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id DiagnosticReport.meta Short description Metadata about the resource Definition The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id DiagnosticReport.implicitRules Short description A set of rules under which this content was created Definition A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
language		0..1	codeBinding	There are no (further) constraints on this element Element id DiagnosticReport.language Short description Language of the resource content Definition The base language in which the resource is written. 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). Data type code Binding IETF language tag for a human language AllLanguages (required) Additional bindings: CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
text	I	0..1	Narrative	There are no (further) constraints on this element Element id DiagnosticReport.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display 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. 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A rim: Act.text?
contained	I	0..*	Resource	Element id DiagnosticReport.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources 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. 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. Data type Resource Sliced: Unordered, Open, by $this(Type) Mappings rim: n/a rim: Entity. Role, or Act rim: N/A
CGM_Observation	I	0..*	CGM_Observation	Element id DiagnosticReport.contained:CGM_Observation Short description Measurements and simple assertions Alternate names inline resources, anonymous resources, contained resources, Vital Signs, Measurement, Results, Tests Definition Measurements and simple assertions made about a patient, device or other subject. Comments Used for simple observations such as device measurements, laboratory atomic results, vital signs, height, weight, smoking status, comments, etc. Other resources are used to provide context for observations such as laboratory reports, etc. Data type CGM_Observation Constraints dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.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-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-6: A resource should have narrative for robust management text.`div`.exists() dom-5: If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` obs-7: If Observation.component.code is the same as Observation.code, then Observation.value SHALL NOT be present (the Observation.component.value[x] holds the value). `value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()` obs-8: bodyStructure SHALL only be present if Observation.bodySite is not present `bodySite.exists() implies bodyStructure.empty()` obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present `dataAbsentReason.empty() or value.empty()` Mappings rim: n/a rim: Entity. Role, or Act rim: N/A rim: Entity, Role, or Act workflow: Event w5: clinical.diagnostics sct-concept: < 363787002 \|Observable entity\| v2: OBX rim: Observation[classCode=OBS, moodCode=EVN]
extension	I	0..*	Extension	There are no (further) constraints on this element Element id DiagnosticReport.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id DiagnosticReport.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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). Requirements Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
identifier	Σ I	0..0	Identifier	There are no (further) constraints on this element Element id DiagnosticReport.identifier Short description Business identifier for report Alternate names ReportID, Filler ID, Placer ID Definition Identifiers assigned to this report by the performer or other systems. Requirements Need to know what identifier to use when making queries about this report from the source laboratory, and for linking to the report outside FHIR context. Comments Usually assigned by the Information System of the diagnostic service provider (filler id). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ident-1: Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason `value.exists()` Mappings rim: n/a v2: CX / EI (occasionally, more often EI maps to a resource id or a URL) rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd: Identifier workflow: Event.identifier w5: FiveWs.identifier v2: OBR-51/ for globally unique filler ID - OBR-3 , For non-globally unique filler-id the flller/placer number must be combined with the universal service Id - OBR-2(if present)+OBR-3+OBR-4 rim: id
basedOn	I	0..0	Reference(CarePlan \| ImmunizationRecommendation \| MedicationRequest \| NutritionOrder \| ServiceRequest)	There are no (further) constraints on this element Element id DiagnosticReport.basedOn Short description What was requested Alternate names Request Definition Details concerning a service requested. Requirements This allows tracing of authorization for the report and tracking whether proposals/recommendations were acted upon. Comments Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single test result resource. Note that there are also cases where one request leads to multiple reports. Data type Reference(CarePlan \| ImmunizationRecommendation \| MedicationRequest \| NutritionOrder \| ServiceRequest) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.basedOn v2: ORC? OBR-2/3? rim: outboundRelationship[typeCode=FLFS].target
status	Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id DiagnosticReport.status Short description registered \| partial \| preliminary \| modified \| final \| amended \| corrected \| appended \| cancelled \| entered-in-error \| unknown Definition The status of the diagnostic report. Requirements Diagnostic services routinely issue provisional/incomplete reports, and sometimes withdraw previously released reports. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Binding The status of the diagnostic report. DiagnosticReportStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Event.status w5: FiveWs.status v2: OBR-25 (not 1:1 mapping) rim: statusCode Note: final and amended are distinguished by whether observation is the subject of a ControlAct event of type "revise"
category	Σ	0..0	CodeableConcept	There are no (further) constraints on this element Element id DiagnosticReport.category Short description Service category Alternate names Department, Sub-department, Service, Discipline 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. 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. Data type CodeableConcept Binding HL7 V2 table 0074 DiagnosticServiceSectionCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD w5: FiveWs.class v2: OBR-24 rim: inboundRelationship[typeCode=COMP].source[classCode=LIST, moodCode=EVN, code < LabService].code
code	Σ	1..1	CodeableConceptBinding	Element id DiagnosticReport.code Short description Name/Code for this diagnostic report Alternate names Type Definition A code or name that describes this diagnostic report. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding LOINC Codes for Diagnostic Reports report-codes (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD workflow: Event.code w5: FiveWs.what[x] v2: OBR-4 (HL7 V2 doesn't provide an easy way to indicate both the ordered test and the performed panel) rim: code
subject	Σ I	0..1	Reference(Patient \| Group \| Device \| Location \| Organization \| Practitioner \| Medication \| Substance \| BiologicallyDerivedProduct)	There are no (further) constraints on this element Element id DiagnosticReport.subject Short description The subject of the report - usually, but not always, the patient Alternate names Patient 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. Requirements SHALL know the subject context. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolvable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data type Reference(Patient \| Group \| Device \| Location \| Organization \| Practitioner \| Medication \| Substance \| BiologicallyDerivedProduct) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.subject w5: FiveWs.subject[x] v2: PID-3 (no HL7 V2 mapping for Group or Device) rim: participation[typeCode=SBJ]
encounter	Σ I	0..0	Reference(Encounter)	There are no (further) constraints on this element Element id DiagnosticReport.encounter Short description Health care event when test ordered Alternate names Context Definition The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport is about. Requirements Links the request to the Encounter context. Comments This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission laboratory tests). Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.encounter w5: FiveWs.context v2: PV1-19 rim: inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
effective[x]	Σ	0..1		There are no (further) constraints on this element Element id DiagnosticReport.effective[x] Short description Clinically relevant time/time-period for report Alternate names Observation time, Effective Time, Occurrence 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. Requirements Need to know where in the patient history to file/present this report. Comments If the diagnostic procedure was performed on the patient, this is the time it was performed. If there are specimens, the diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship between the specimens and the diagnostically relevant time is not always automatic. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a workflow: Event.occurrence[x] w5: FiveWs.done[x] v2: OBR-7 rim: effectiveTime
effectivePeriod			Period	Data type Period
issued	Σ	0..0	instant	There are no (further) constraints on this element Element id DiagnosticReport.issued Short description DateTime this version was made Alternate names Date published, Date Issued, Date Verified Definition The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. Requirements Clinicians need to be able to check the date that the report was released. Comments May be different from the update time of the resource itself, because that is the status of the record (potentially a secondary copy), not the actual release time of the report. Data type instant Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a w5: FiveWs.recorded v2: OBR-22 rim: participation[typeCode=VRF or AUT].time
performer	Σ I	0..*	Reference(Practitioner \| PractitionerRole \| Organization)	Element id DiagnosticReport.performer Short description Responsible Diagnostic Service Alternate names Laboratory, Service, Practitioner, Department, Company, Authorized by, Director Definition The diagnostic service that is responsible for issuing the report. Requirements Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. Comments 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. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.performer.actor w5: FiveWs.actor v2: PRT-8 (where this PRT-4-Participation = "PO") rim: .participation[typeCode=PRF]
resultsInterpreter	Σ I	0..0	Reference(Practitioner \| PractitionerRole \| Organization)	Element id DiagnosticReport.resultsInterpreter Short description Primary result interpreter Alternate names Analyzed by, Reported by Definition The practitioner or organization that is responsible for the report's conclusions and interpretations. Requirements Need to know whom to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis. Comments Might not be the same entity that takes responsibility for the clinical report. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) workflow: Event.performer.actor w5: FiveWs.actor v2: OBR-32, PRT-8 (where this PRT-4-Participation = "PI") rim: .participation[typeCode=PRF]
specimen	I	0..0	Reference(Specimen)	There are no (further) constraints on this element Element id DiagnosticReport.specimen Short description Specimens this report is based on Definition Details about the specimens on which this diagnostic report is based. Requirements Need to be able to report information about the collected specimens on which the report is based. Comments If the specimen is sufficiently specified with a code in the test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per observation or group. Data type Reference(Specimen) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: SPM rim: participation[typeCode=SBJ]
result	I	0..*	Reference(Observation)	There are no (further) constraints on this element Element id DiagnosticReport.result Short description Observations Alternate names Data, Atomic Value, Result, Atomic result, Data, Test, Analyte, Battery, Organizer Definition Observations that are part of this diagnostic report. Requirements Need to support individual results, or groups of results, where the result grouping is arbitrary, but meaningful. Comments Observations can contain observations. Data type Reference(Observation) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2: OBXs rim: outboundRelationship[typeCode=COMP].target
note		0..0	Annotation	There are no (further) constraints on this element Element id DiagnosticReport.note Short description Comments about the diagnostic report Definition Comments about the diagnostic report. Requirements Need to be able to provide free text additional information. 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. Data type Annotation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: N/A rim: Act rim: unknown
study	I	0..0	Reference(GenomicStudy \| ImagingStudy)	There are no (further) constraints on this element Element id DiagnosticReport.study Short description Reference to full details of an analysis associated with the diagnostic report 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. 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. Data type Reference(GenomicStudy \| ImagingStudy) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
supportingInfo		0..0	BackboneElement	There are no (further) constraints on this element Element id DiagnosticReport.supportingInfo Short description Additional information supporting the diagnostic report 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a
media	Σ	0..0	BackboneElement	There are no (further) constraints on this element Element id DiagnosticReport.media Short description Key images or data associated with this report Alternate names DICOM, Slides, Scans 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). Requirements Many diagnostic services include images or data in the report as part of their service. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: OBX? rim: outboundRelationship[typeCode=COMP].target
composition	I	0..0	Reference(Composition)	There are no (further) constraints on this element Element id DiagnosticReport.composition Short description Reference to a Composition resource for the DiagnosticReport structure Definition Reference to a Composition resource instance that provides structure for organizing the contents of the DiagnosticReport. 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. Data type Reference(Composition) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1: SHALL have a contained resource if a local reference is provided `reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))` ref-2: At least one of reference, identifier and display SHALL be present (unless an extension is provided). `reference.exists() or identifier.exists() or display.exists() or extension.exists()` Mappings rim: n/a rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim: .value.reference
conclusion		0..0	markdown	There are no (further) constraints on this element Element id DiagnosticReport.conclusion Short description Clinical conclusion (interpretation) of test results Alternate names Report Definition Concise and clinically contextualized summary conclusion (interpretation/impression) of the diagnostic report. Requirements Need to be able to provide a conclusion that is not lost among the basic result data. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data type markdown Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: OBX rim: inboundRelationship[typeCode="SPRT"].source[classCode=OBS, moodCode=EVN, code=LOINC:48767-8].value (type=ST)
conclusionCode		0..0	CodeableConcept	There are no (further) constraints on this element Element id DiagnosticReport.conclusionCode Short description Codes for the clinical conclusion of test results Definition One or more codes that represent the summary conclusion (interpretation/impression) of the diagnostic report. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data type CodeableConcept Binding SNOMED CT Clinical Findings SNOMEDCTClinicalFindings (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD v2: OBX rim: inboundRelationship[typeCode=SPRT].source[classCode=OBS, moodCode=EVN, code=LOINC:54531-9].value (type=CD)
presentedForm	I	0..*	Attachment	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm Short description Entire report as issued Definition Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent. Requirements Gives laboratory the ability to provide its own fully formatted report for clinical fidelity. Comments "application/pdf" is recommended as the most reliable and interoperable in this context. Data type Attachment Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1: If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim: n/a v2: ED/RP rim: ED v2: OBX rim: text (type=ED)
id		0..1	string	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a rim: N/A
contentType	Σ I	0..1	codeBinding	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.contentType Short description Mime type of the content, with charset etc. 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. Requirements Processors of the data need to be able to know how to interpret the data. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Binding BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) MimeTypes (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General text/plain; charset=UTF-8, image/png Mappings rim: n/a v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used rim: ./mediaType, ./charset
language	Σ	0..1	codeBinding	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.language Short description Human language of the content (BCP-47) Definition The human language of the content. The value can be any valid value according to BCP 47. Requirements Users need to be able to choose between the languages in a set of attachments. Comments Note that FHIR strings SHALL NOT exceed 1,048,576 (10241024) characters in size Data type* code Binding IETF language tag for a human language. AllLanguages (required) Additional bindings: CommonLanguages (starter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General en-AU Mappings rim: n/a rim: ./language
data	I	0..1	base64Binary	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.data Short description Data inline, base64ed Definition The actual data of the attachment - a sequence of bytes, base64 encoded. Requirements The data needs to able to be transmitted inline. Comments The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a v2: ED.5 rim: ./data
url	Σ	0..1	url	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.url Short description Uri where the data can be found Definition A location where the data can be accessed. Requirements The data needs to be transmitted by reference. 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. Data type url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/logo-small.png Mappings rim: n/a v2: RP.1+RP.2 - if they refer to a URL (see v2.6) rim: ./reference/literal
size	Σ	0..1	integer64	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.size Short description Number of bytes of content (if url provided) Definition The number of bytes of data that make up this attachment (before base64 encoding, if that is done). Requirements Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all. 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. Data type integer64 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A (needs data type R3 proposal)
hash	Σ	0..1	base64Binary	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.hash Short description Hash of the data (sha-1, base64ed) Definition The calculated hash of the data using SHA-1. Represented using base64. 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). 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. Data type base64Binary Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
title	Σ	0..1	string	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.title Short description Label to display in place of the data Definition A label or set of text to display in place of the data. 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. Comments May sometimes be derived from the source filename. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General Official Corporate Logo Mappings rim: n/a rim: ./title/data
creation	Σ	0..1	dateTime	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.creation Short description Date attachment was first created Definition The date that the attachment was first created. Requirements This is often tracked as an integrity issue for use of the attachment. Comments UTC offset is allowed for dates and partial dates Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: N/A (needs data type R3 proposal)
height		0..1	positiveInt	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.height Short description Height of the image in pixels (photo/video) Definition Height of the image in pixels (photo/video). Comments 32 bit number; for values larger than this, use decimal Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
width		0..1	positiveInt	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.width Short description Width of the image in pixels (photo/video) Definition Width of the image in pixels (photo/video). Comments 32 bit number; for values larger than this, use decimal Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
frames		0..0	positiveInt	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.frames Short description Number of frames if > 1 (photo) 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. 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. Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
duration		0..1	decimal	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.duration Short description Length in seconds (audio / video) Definition The duration of the recording in seconds - for audio and video. Comments The duration might differ from occurrencePeriod if recording was paused. Data type decimal Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a rim: .outboundRelationship[typeCode="COMP].target[classCode="OBS", moodCode="EVN",code="<CODE>"].value
pages		0..1	positiveInt	There are no (further) constraints on this element Element id DiagnosticReport.presentedForm.pages Short description Number of printed pages Definition The number of pages when printed. Comments 32 bit number; for values larger than this, use decimal Data type positiveInt Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: n/a

Attribute description :

Attribute	Description	Terminology reference
status	status of diagnostic report	status
code	Standard code defines the report type is a ARG report.	To be updated report-codes
Subject	Subject on which the report was derived. i.e patient
effectiveDateTime	The date time observed value is asserted as being true.
performer	Organization or HCP responsible for issuing the report.
result	Reference to the observations that are part of this report.
presentedForm	representation of the entire result in the report.

DiagnosticReport

example - AGP report