DiagnosticReport $write

post/DiagnosticReport/$write
Page View

This resource contains clinical context for diagnostic tests (e.g., lab tests, pathology, imaging) performed on a patient or group of patients. Diagnostic reports comprise discrete results, images, or codes. 

You can receive, retrieve, or save details for diagnostic reports. 

Supported fields

We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the US Core profile.

$write

This operation allows you to save new or updated discrete diagnostic results to a patient’s chart after completing some kind of testing for a patient.

Request parameters and payload

Select example

cURL request example

cURL
curl 'https://api.redoxengine.com/fhir/R4/{destinationId}/{environmentFlag}/DiagnosticReport/$write' \
--request POST \
--header 'Authorization: Bearer $API_TOKEN' \
--header 'Content-Type: application/fhir+json' \
--data '{
  "resourceType": "Bundle",
  "id": "RedoxDiagnosticReportExampleCBCBundle",
  "type": "message",
  "entry": [
    {
      "resource": {
        "resourceType": "MessageHeader",
        "id": "RedoxMessageHeaderExample",
        "source": {
          "name": "Good Health Clinics",
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
        },
        "eventCoding": {
          "system": "urn:redox:event-type",
          "code": "DiagnosticReport-New"
        }
      }
    },
    {
      "resource": {
        "resourceType": "Patient",
        "id": "RedoxPatientExampleTimothyMinimal",
        "identifier": [
          {
            "value": "0000000001",
            "system": "urn:redox:health-one:MR"
          },
          {
            "value": "101-01-0001",
            "system": "http://hl7.org/fhir/sid/us-ssn"
          }
        ],
        "name": [
          {
            "given": [
              "Timothy",
              "Paul"
            ],
            "family": "Bixby"
          }
        ],
        "gender": "male",
        "birthDate": "2008-01-06"
      }
    },
    {
      "resource": {
        "resourceType": "DiagnosticReport",
        "id": "RedoxDiagnosticReportExampleCBC",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/v2-0074",
                "code": "LAB"
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.696871",
            "value": "7923457256"
          }
        ],
        "subject": {
          "reference": "Patient/RedoxPatientExampleTimothy"
        },
        "effectiveDateTime": "2022-02-14T19:20:02.762Z",
        "issued": "2022-02-15T19:22:41.919Z",
        "status": "final",
        "specimen": [
          {
            "reference": "Specimen/RedoxSpecimenExample"
          }
        ],
        "code": {
          "coding": [
            {
              "code": "43789009",
              "system": "http://snomed.info/sct"
            }
          ],
          "text": "CBC WO DIFFERENTIAL"
        },
        "performer": [
          {
            "reference": "Practitioner/fc5ed2f0-a7a8-4bc6-bcc1-8f72db850a5c"
          }
        ],
        "result": [
          {
            "reference": "Observation/RedoxHGBObservationExample"
          },
          {
            "reference": "Observation/RedoxWBCObservationExample"
          },
          {
            "reference": "Observation/RedoxPlateletObservationExample"
          }
        ],
        "presentedForm": [
          {
            "contentType": "application/pdf",
            "url": "https://blob.redoxengine.com/123456789",
            "title": "SamplePDF-Diagnostic Report 1"
          },
          {
            "contentType": "application/pdf",
            "data": "PC4uLmJhc2UgNjQgZmlsZSBjb250ZW50cy4uLj4=",
            "title": "SamplePDF-Diagnostic Report 2"
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "id": "RedoxHGBObservationExample",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory"
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
            "value": "6492428347"
          }
        ],
        "status": "final",
        "subject": {
          "reference": "Patient/RedoxPatientExampleTimothy"
        },
        "code": {
          "coding": [
            {
              "code": "30313-1",
              "system": "http://loinc.org"
            }
          ],
          "text": "HGB"
        },
        "specimen": {
          "reference": "RedoxSpecimen"
        },
        "issued": "2022-02-16T17:26:19.778Z",
        "valueQuantity": {
          "value": 10.2,
          "unit": "g/dl"
        },
        "note": [
          {
            "text": "An observation result note"
          }
        ],
        "referenceRange": [
          {
            "low": {
              "value": 13.5
            },
            "high": {
              "value": 17.5
            }
          }
        ],
        "interpretation": [
          {
            "coding": [
              {
                "code": "L",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "display": "Low"
              }
            ]
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "id": "RedoxWBCObservationExample",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory"
              }
            ]
          }
        ],
        "valueQuantity": {
          "value": 10.3,
          "_value": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/quantity-precision",
                "valueInteger": 2
              }
            ]
          },
          "unit": "10+3/ul"
        },
        "identifier": [
          {
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
            "value": "5287452345"
          }
        ],
        "status": "final",
        "subject": {
          "reference": "Patient/RedoxPatientExampleTimothy"
        },
        "code": {
          "coding": [
            {
              "code": "33765-9",
              "system": "http://loinc.org"
            }
          ],
          "text": "WBC"
        },
        "specimen": {
          "reference": "RedoxSpecimen"
        },
        "issued": "2022-02-16T17:26:19.778Z",
        "note": [
          {
            "text": "An observation result note"
          }
        ],
        "interpretation": [
          {
            "coding": [
              {
                "code": "N",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "display": "Normal"
              }
            ]
          }
        ]
      }
    },
    {
      "resource": {
        "resourceType": "Observation",
        "id": "RedoxPlateletObservationExample",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "laboratory"
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
            "value": "4910481243"
          }
        ],
        "status": "final",
        "subject": {
          "reference": "Patient/RedoxPatientExampleTimothy"
        },
        "code": {
          "coding": [
            {
              "code": "26515-7",
              "system": "http://loinc.org"
            }
          ],
          "text": "Platelets"
        },
        "specimen": {
          "reference": "RedoxSpecimen"
        },
        "issued": "2022-02-16T17:26:19.778Z",
        "valueQuantity": {
          "value": 201,
          "unit": "10+3/ul"
        },
        "note": [
          {
            "text": "An observation result note"
          }
        ],
        "interpretation": [
          {
            "coding": [
              {
                "code": "N",
                "system": "http://terminology.hl7.org/CodeSystem/v3-ObservationInterpretation",
                "display": "Normal"
              }
            ]
          }
        ]
      }
    }
  ]
}'

Request Body Schema

  • resourceType
    required, string

    Identifies the type of the resource

    Value: Bundle
  • type
    required, string

    Identifies this bundle as a message

    Value: message
  • entry
    required, Array of MessageHeader, Patient, Observation, DiagnosticReport or Other

    An array of FHIR resources. At a minimum, a Diagnostic Report should include the following entries:

    • Patient - the patient
    • Observation - an observation related to a diagnostic report
    • DiagnosticReport - the diagnostic reports related to the patient

      An entry in the bundle containing a FHIR resource

    • resource
      required, object

      Additional metadata about the message including the event

      • resourceType
        required, string

        Identifies the type of the resource

        Value: MessageHeader
      • source
        required, object

        Information about the sender of the message. This will typically be populated by Redox.

        • endpoint
          required, string

          Identifies the routing target to send acknowledgements to.

        • name
          string

          Human-readable name for the source system.

      • eventCoding
        required, object

        This describes the message being communicated

        • system
          string

          The identification of the code system that defines the meaning of the symbol in the code.

        • code
          string

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          Value: DiagnosticReport-New
  • timestamp
    string

    The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.

Response fields and example

Example

"Operation Response"