# HeyDonto FHIR R4 API - Diagnostic The Diagnostics Module provides an overview and guide to the FHIR content that addresses ordering and reporting of clinical diagnostics including laboratory testing, imaging and genomics. --- ## Index The Diagnostics module covers the following resources: * [Observation](https://hl7.org/fhir/R4/observation.html) - Measurements and simple assertions made about a patient, device or other subject * [DiagnosticReport](https://hl7.org/fhir/R4/diagnosticreport.html) - The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports * [ServiceRequest](https://hl7.org/fhir/R4/servicerequest.html) - A record of a request for service such as diagnostic investigations, treatments, or operations to be performed * [Media](https://hl7.org/fhir/R4/media.html) - A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference * [ImagingStudy](https://hl7.org/fhir/R4/imagingstudy.html) - Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities * [MolecularSequence](https://hl7.org/fhir/R4/molecularsequence.html) - Raw data describing a biological sequence * [Specimen](https://hl7.org/fhir/R4/specimen.html) - A sample to be used for analysis * [BodyStructure](https://hl7.org/fhir/R4/bodystructure.html) - Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case The diagnostic resources and their relationships are shown below. The arrows represent the direction of the references between resources (for example, DiagnosticReport references ServiceRequest). See the [Workflow Module](https://hl7.org/fhir/R4/workflow-module.html) for information about the coordination of activities such as ordering and fulfilling of diagnostics. ![Diagnostic Module Resources](/images/diagnostic-module-resources.png) **Implementation Note:** See the [Genomics Implementation Guidance](https://hl7.org/fhir/R4/genomics.html) for additional information about how to use the Diagnostic resources for Clinical Genomic Reporting and Analysis. --- ## Security and Privacy The diagnostic resources often represent patient-specific data, and as such are susceptible to data breaching. Necessary privacy and security provisions must be in place when searching and fetching this information. For more general considerations, see [the Security and Privacy module](https://hl7.org/fhir/R4/secpriv-module.html). --- ## Common Use Cases Diagnostic resources are commonly used to plan, recommend, order and report clinical diagnostics: * Planning a diagnostic test such as in this [Careplan-example](https://hl7.org/fhir/R4/careplan-example-f203-sepsis.html) * Recommending diagnostics such as is done by Clinical Decision Support tools. See the [Clinical Reasoning module](https://hl7.org/fhir/R4/clinicalreasoning-module.html) for more information * Ordering a Laboratory Test such as a [lipid panel](https://hl7.org/fhir/R4/servicerequest-example-lipid.html) * Reporting a Laboratory Test such as a [lipid panel](https://hl7.org/fhir/R4/diagnosticreport-example-lipids.html) * Ordering an imaging study such as a [CT study](https://hl7.org/fhir/R4/servicerequest-example-di.html) * Reporting an imaging study such as a [CT study](https://hl7.org/fhir/R4/imagingstudy-example.html) * Ordering a genetic test such as a [gene mutation analysis](https://hl7.org/fhir/R4/servicerequest-genetics-example-1.html) * Reporting a genetic test such as [HLA genotyping](https://hl7.org/fhir/R4/diagnosticreport-hla-genetics-results-example.html) There are many ways to use these resources independently as well. The Observation resource, in particular, is central to capturing many measurements and events in healthcare and is often used outside the context of diagnostic orders and reports: * Recording vital signs such as [temperature](https://hl7.org/fhir/R4/observation-example-f202-temperature.html) * Recording other observations of a patient's social history such as tobacco use * Recording other characteristics of a patient such as pregnancy status (note: The Condition resource may be used to represent these as well) * Recording clinical assessment tool scores such as an [Apgar score](https://hl7.org/fhir/R4/observation-example-5minute-apgar-score.html) * Identifying and describing a [specimen](https://hl7.org/fhir/R4/specimen-example-serum.html) or [body site](https://hl7.org/fhir/R4/bodystructure-example-tumor.html) --- ## Related Resources and Modules The resources that represent the basic information about a patient and a clinical encounter can be found in the [Administration Module](https://hl7.org/fhir/R4/administration-module.html). Other resources that represent core clinical information generated by healthcare providers during the course of a patient encounter are detailed in the [Clinical Summary Module](https://hl7.org/fhir/R4/clinicalsummary-module.html) and the [Medications Module](https://hl7.org/fhir/R4/medications-module.html). --- ## Developmental Roadmap * The *Observation* and *Diagnostic Report* resources have been tested and used in production tooling and as such have reached a [maturity level FMM=4](https://hl7.org/fhir/R4/versions.html#maturity) where changes become less likely and require implementer community approval. Future work will focus on developing core profiles and clarifying use cases and boundaries and providing more domain specific examples. We anticipate *Observation* and *Diagnostic Report* reaching normative status by the end of this cycle. * The *ImagingStudy* resource has had some limited testing and use. Further use of this resource in production tooling is needed for it to reach a more stable FMM level. * The *ServiceRequest* resources has undergone substantial changes since DSTU2. Foremost of which is the merging of DSTU2 *DiagnosticOrder* and *ServiceRequest* into a single resource. In addition, as a result of the addition of [FHIR workflow](https://hl7.org/fhir/R4/workflow.html) for STU3, its structure and content have been updated to align with the general FHIR workflow "request" pattern. Because of these, it remains a relatively immature resource. No more sweeping changes to its structure are expected. However, its scope and boundaries vis a vis other resources will be the topic of future workgroup efforts. We anticipate its broad use by implementers and that it will mature as a resource throughout the upcoming cycle. * The *Specimen* resource will be the focus of work group efforts for the upcoming cycle. A new *SpecimenDefinition* resource is planned for describing specimen types vs specimen instances and will take over some of the Specimen resource's current scope. We expect to see more widespread use of this resource and future updates to its FMM level. * The *MolecularSequence* resource remains draft and we expect to see more widespread use of this resource and future updates to its FMM level. * The *BodyStructure* resource is an immature resource with a FMM level of 1. To date there has been little implementation feedback. * The *Media* resource is the newest member to the Diagnostics module having undergone substantial scope and structural changes to create a specialized observation resource focused on digital media such as images and audio files. Future work will focus on developing core profiles and providing more domain specific examples. Version: 1.0 ## Servers Sandbox ``` https://api-staging.heydonto.com ``` Production ``` https://api.heydonto.com ``` ## Security ### bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [HeyDonto FHIR R4 API - Diagnostic](https://docs.heydonto.com/_bundle/apis/fhir/diagnostic.yaml) ## BodyStructure ### Get FHIR r4 body structures - [GET /site/{siteId}/fhir/body-structure](https://docs.heydonto.com/apis/fhir/diagnostic/bodystructure/fhirbodystructurecontroller_getbodystructures.md) ### Create FHIR r4 body structure - [POST /site/{siteId}/fhir/body-structure](https://docs.heydonto.com/apis/fhir/diagnostic/bodystructure/fhirbodystructurecontroller_createbodystructure.md) ### Get FHIR r4 body structure by ID - [GET /site/{siteId}/fhir/body-structure/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/bodystructure/fhirbodystructurecontroller_getbodystructure.md) ### Update FHIR r4 body structure - [PUT /site/{siteId}/fhir/body-structure/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/bodystructure/fhirbodystructurecontroller_updatebodystructure.md) ### Delete FHIR r4 body structure - [DELETE /site/{siteId}/fhir/body-structure/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/bodystructure/fhirbodystructurecontroller_deletebodystructure.md) ### Get FHIR r4 body structure history by ID - [GET /site/{siteId}/fhir/body-structure/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/bodystructure/fhirbodystructurecontroller_getbodystructurehistory.md) ## DiagnosticReport ### Get FHIR r4 diagnostic reports - [GET /site/{siteId}/fhir/diagnostic-report](https://docs.heydonto.com/apis/fhir/diagnostic/diagnosticreport/fhirdiagnosticreportcontroller_getdiagnosticreports.md) ### Create FHIR r4 diagnostic report - [POST /site/{siteId}/fhir/diagnostic-report](https://docs.heydonto.com/apis/fhir/diagnostic/diagnosticreport/fhirdiagnosticreportcontroller_creatediagnosticreport.md) ### Get FHIR r4 diagnostic report by ID - [GET /site/{siteId}/fhir/diagnostic-report/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/diagnosticreport/fhirdiagnosticreportcontroller_getdiagnosticreport.md) ### Update FHIR r4 diagnostic report - [PUT /site/{siteId}/fhir/diagnostic-report/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/diagnosticreport/fhirdiagnosticreportcontroller_updatediagnosticreport.md) ### Delete FHIR r4 diagnostic report - [DELETE /site/{siteId}/fhir/diagnostic-report/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/diagnosticreport/fhirdiagnosticreportcontroller_deletediagnosticreport.md) ### Get FHIR r4 diagnostic report history by ID - [GET /site/{siteId}/fhir/diagnostic-report/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/diagnosticreport/fhirdiagnosticreportcontroller_getdiagnosticreporthistory.md) ## ImagingStudy ### Get FHIR r4 imaging studys - [GET /site/{siteId}/fhir/imaging-study](https://docs.heydonto.com/apis/fhir/diagnostic/imagingstudy/fhirimagingstudycontroller_getimagingstudys.md) ### Create FHIR r4 imaging study - [POST /site/{siteId}/fhir/imaging-study](https://docs.heydonto.com/apis/fhir/diagnostic/imagingstudy/fhirimagingstudycontroller_createimagingstudy.md) ### Get FHIR r4 imaging study by ID - [GET /site/{siteId}/fhir/imaging-study/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/imagingstudy/fhirimagingstudycontroller_getimagingstudy.md) ### Update FHIR r4 imaging study - [PUT /site/{siteId}/fhir/imaging-study/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/imagingstudy/fhirimagingstudycontroller_updateimagingstudy.md) ### Delete FHIR r4 imaging study - [DELETE /site/{siteId}/fhir/imaging-study/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/imagingstudy/fhirimagingstudycontroller_deleteimagingstudy.md) ### Get FHIR r4 imaging study history by ID - [GET /site/{siteId}/fhir/imaging-study/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/imagingstudy/fhirimagingstudycontroller_getimagingstudyhistory.md) ## Media ### Get FHIR r4 medias - [GET /site/{siteId}/fhir/media](https://docs.heydonto.com/apis/fhir/diagnostic/media/fhirmediacontroller_getmedias.md) ### Create FHIR r4 media - [POST /site/{siteId}/fhir/media](https://docs.heydonto.com/apis/fhir/diagnostic/media/fhirmediacontroller_createmedia.md) ### Get FHIR r4 media by ID - [GET /site/{siteId}/fhir/media/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/media/fhirmediacontroller_getmedia.md) ### Update FHIR r4 media - [PUT /site/{siteId}/fhir/media/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/media/fhirmediacontroller_updatemedia.md) ### Delete FHIR r4 media - [DELETE /site/{siteId}/fhir/media/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/media/fhirmediacontroller_deletemedia.md) ### Get FHIR r4 media history by ID - [GET /site/{siteId}/fhir/media/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/media/fhirmediacontroller_getmediahistory.md) ## MolecularSequence ### Get FHIR r4 molecular sequences - [GET /site/{siteId}/fhir/molecular-sequence](https://docs.heydonto.com/apis/fhir/diagnostic/molecularsequence/fhirmolecularsequencecontroller_getmolecularsequences.md) ### Create FHIR r4 molecular sequence - [POST /site/{siteId}/fhir/molecular-sequence](https://docs.heydonto.com/apis/fhir/diagnostic/molecularsequence/fhirmolecularsequencecontroller_createmolecularsequence.md) ### Get FHIR r4 molecular sequence by ID - [GET /site/{siteId}/fhir/molecular-sequence/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/molecularsequence/fhirmolecularsequencecontroller_getmolecularsequence.md) ### Update FHIR r4 molecular sequence - [PUT /site/{siteId}/fhir/molecular-sequence/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/molecularsequence/fhirmolecularsequencecontroller_updatemolecularsequence.md) ### Delete FHIR r4 molecular sequence - [DELETE /site/{siteId}/fhir/molecular-sequence/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/molecularsequence/fhirmolecularsequencecontroller_deletemolecularsequence.md) ### Get FHIR r4 molecular sequence history by ID - [GET /site/{siteId}/fhir/molecular-sequence/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/molecularsequence/fhirmolecularsequencecontroller_getmolecularsequencehistory.md) ## Observation ### Get FHIR r4 observations - [GET /site/{siteId}/fhir/observation](https://docs.heydonto.com/apis/fhir/diagnostic/observation/fhirobservationcontroller_getobservations.md) ### Create FHIR r4 observation - [POST /site/{siteId}/fhir/observation](https://docs.heydonto.com/apis/fhir/diagnostic/observation/fhirobservationcontroller_createobservation.md) ### Get FHIR r4 observation by ID - [GET /site/{siteId}/fhir/observation/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/observation/fhirobservationcontroller_getobservation.md) ### Update FHIR r4 observation - [PUT /site/{siteId}/fhir/observation/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/observation/fhirobservationcontroller_updateobservation.md) ### Delete FHIR r4 observation - [DELETE /site/{siteId}/fhir/observation/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/observation/fhirobservationcontroller_deleteobservation.md) ### Get FHIR r4 observation history by ID - [GET /site/{siteId}/fhir/observation/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/observation/fhirobservationcontroller_getobservationhistory.md) ## ObservationDefinition ### Get FHIR r4 observation definitions - [GET /site/{siteId}/fhir/observation-definition](https://docs.heydonto.com/apis/fhir/diagnostic/observationdefinition/fhirobservationdefinitioncontroller_getobservationdefinitions.md) ### Create FHIR r4 observation definition - [POST /site/{siteId}/fhir/observation-definition](https://docs.heydonto.com/apis/fhir/diagnostic/observationdefinition/fhirobservationdefinitioncontroller_createobservationdefinition.md) ### Get FHIR r4 observation definition by ID - [GET /site/{siteId}/fhir/observation-definition/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/observationdefinition/fhirobservationdefinitioncontroller_getobservationdefinition.md) ### Update FHIR r4 observation definition - [PUT /site/{siteId}/fhir/observation-definition/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/observationdefinition/fhirobservationdefinitioncontroller_updateobservationdefinition.md) ### Delete FHIR r4 observation definition - [DELETE /site/{siteId}/fhir/observation-definition/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/observationdefinition/fhirobservationdefinitioncontroller_deleteobservationdefinition.md) ### Get FHIR r4 observation definition history by ID - [GET /site/{siteId}/fhir/observation-definition/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/observationdefinition/fhirobservationdefinitioncontroller_getobservationdefinitionhistory.md) ## Specimen ### Get FHIR r4 specimens - [GET /site/{siteId}/fhir/specimen](https://docs.heydonto.com/apis/fhir/diagnostic/specimen/fhirspecimencontroller_getspecimens.md) ### Create FHIR r4 specimen - [POST /site/{siteId}/fhir/specimen](https://docs.heydonto.com/apis/fhir/diagnostic/specimen/fhirspecimencontroller_createspecimen.md) ### Get FHIR r4 specimen by ID - [GET /site/{siteId}/fhir/specimen/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/specimen/fhirspecimencontroller_getspecimen.md) ### Update FHIR r4 specimen - [PUT /site/{siteId}/fhir/specimen/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/specimen/fhirspecimencontroller_updatespecimen.md) ### Delete FHIR r4 specimen - [DELETE /site/{siteId}/fhir/specimen/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/specimen/fhirspecimencontroller_deletespecimen.md) ### Get FHIR r4 specimen history by ID - [GET /site/{siteId}/fhir/specimen/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/specimen/fhirspecimencontroller_getspecimenhistory.md) ## SpecimenDefinition ### Get FHIR r4 specimen definitions - [GET /site/{siteId}/fhir/specimen-definition](https://docs.heydonto.com/apis/fhir/diagnostic/specimendefinition/fhirspecimendefinitioncontroller_getspecimendefinitions.md) ### Create FHIR r4 specimen definition - [POST /site/{siteId}/fhir/specimen-definition](https://docs.heydonto.com/apis/fhir/diagnostic/specimendefinition/fhirspecimendefinitioncontroller_createspecimendefinition.md) ### Get FHIR r4 specimen definition by ID - [GET /site/{siteId}/fhir/specimen-definition/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/specimendefinition/fhirspecimendefinitioncontroller_getspecimendefinition.md) ### Update FHIR r4 specimen definition - [PUT /site/{siteId}/fhir/specimen-definition/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/specimendefinition/fhirspecimendefinitioncontroller_updatespecimendefinition.md) ### Delete FHIR r4 specimen definition - [DELETE /site/{siteId}/fhir/specimen-definition/{id}](https://docs.heydonto.com/apis/fhir/diagnostic/specimendefinition/fhirspecimendefinitioncontroller_deletespecimendefinition.md) ### Get FHIR r4 specimen definition history by ID - [GET /site/{siteId}/fhir/specimen-definition/{id}/history](https://docs.heydonto.com/apis/fhir/diagnostic/specimendefinition/fhirspecimendefinitioncontroller_getspecimendefinitionhistory.md)