1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. DiagnosticReport

Create a diagnostic report

post

/DiagnosticReport

Creates a new diagnostic report.

Note:

  • Cardiology and anatomic pathology reports are supported for the create operation.
  • Only the body fields mentioned below are supported. Unsupported fields are ignored or can result in errors.
  • All provided dates must have a time component.
  • The following MIME types are supported:
    • application/pdf
    • text/plain
    • text/richtext
    • text/rtf
    • text/html
    • application/xml
    • application/xhtml+xml
  • The API to create a cardiology diagnostic report requires a default user that is set up in the domain to chart a document. If a default user is not defined in the domain, a results_interpreter attribute is mandatory to chart a cardiology document.

Authorization Types

This operation supports the following authorization types:

Request

Supported Media Types
Header Parameters
Body ()
The body of the create operation
Root Schema : DiagnosticReportCreate
Type: object
A summary representation of the create (POST) operation for a diagnostic report.
Show Source
  • basedOn
    Details concerning a service requested.
    Note: Only the anatomic pathology concept supports the basedOn field. Must contain ServiceRequest references with valid Millennium IDs.
    Example: 
    {
  "basedOn": [
    {
        "reference": "ServiceRequest/99928073"
    }
  ]
}
  • category
    A code that classifies the clinical discipline, department, or diagnostic service that created the report (such as cardiology or anatomic pathology). This code is used for searching, sorting, and display purposes.
    Note: The code must be LP29708-2 for a cardiology concept and LP7839-6 for an anatomic pathology concept.
    Example: 
    {
  "category": [
    {
        "coding": [
            {
                "code": "LP29708-2",
                "display": "Cardiology",
                "isUserSelected": false,
                "system": "http://loinc.org"
            }
        ],
        "text": "string"
    }
  ]
}
    {
  "category": [
    {
        "coding": [
            {
                "code": "LP7839-6",
                "display": "Pathology study",
                "isUserSelected": false,
                "system": "http://loinc.org"
            }
        ],
        "text": "string"
    }
  ]
}
  • code
    Specifies the particular type of diagnostic report.
    Note:
    • The code must include a LOINC or proprietary coding but not both together.
    • Multiple LOINC codings or a single proprietary coding can be provided.
    • When providing a proprietary code system, ensure that the format is https://fhir.cerner.com/[your EHR source ID]/codeSet/[code set], where the code set is Millennium Code Set 72. Example: 
      https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72
    Example: 
    {
  "code": {
    "coding": [
        {
            "code": "703535",
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
            "userSelected": true,
            "display": "Temperature Axillary"
        }
    ],
    "text": "Cardiology"
  }
}
    {
  "code": {
    "coding": [
        {
            "code": "4187236",
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
            "userSelected": true,
            "display": "Anatomic Pathology"
        }
    ],
    "text": "Anatomic Pathology"
  }
}
  • A concise and clinically contextualized summary conclusion (interpretation or impression) of the diagnostic report.
    Note: Only the cardiology concept supports conclusion field. Must be able to provide a conclusion that is not lost among the basic result data.
    Example: 
    {
  "conclusion": "conclusion string"
}
  • The time or time period that the observed values are related to. When the subject of the report is a patient, the effectiveDateTime is usually the time of the procedure or specimen collection. The source of the date and time is often unknown, and only the date and time itself is known.
    Note: Only the anatomic pathology concept supports the effectiveDateTime field.
    Example: 
    {
  "effectiveDateTime": "2020-12-27T09:12:28Z",
}
  • effectivePeriod
    The time or time period that the observed values are related to. When the subject of the report is a patient, the effectivePeriod is usually the time of the procedure or specimen collection. The source of the date and time is often unknown, and only the date and time itself is known.
    Note: Only the cardiology concept supports the effectivePeriod field.
    Example: 
    {
  "effectivePeriod": {
    "start": "2020-09-14T09:05:12.000Z",
    "end": "2020-09-14T09:05:12.000Z"
  }
}
  • encounter
    The healthcare event (such as a patient and healthcare provider interaction) that this diagnostic report is about.
    Note: The encounter has to match the original document encounter.
    Example: 
    {
  "encounter": {
    "reference": "Encounter/98041577"
  }
}
  • identifier
    Identifiers assigned to this report by the performer or other systems.
    Note:
    • The identifier for the cardiology concept must include the use, type, system, and value fields.
    • The type field would include coding.
    • coding internally would include code, system, version, display, and userSelected.
    • The identifier for the anatomic pathology concept must include the system and value fields.
    Example: 
    {
  "identifier": [
    {
        "use": "usual",
        "type": {
            "coding": [
                {
                    "code": "Coding",
                    "system": "http://snomed.info/sct",
                    "version": "4.0.1",
                    "display": "test",
                    "userSelected": true
                }
            ]
        },
        "system": "http://hl7.org/fhir/sid/us-ssn",
        "value": "11182456"
    }
  ]
}
    {
  "identifier": [
    {
        "system": "https://fhir.cerner.com/ceuuid",
        "value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-34824240-2022051205454801"
    }
  ]
}
  • The date and time when this version of the report was made available to providers, typically after the report was reviewed and verified.
    Note: A time component must be provided with the date.
    Example: 
    {
  "issued": "2020-07-29T21:02:04.000Z"
}
  • meta
    The DiagnosticReport metadata.
  • performer
    The diagnostic service that is responsible for issuing the report.
    Note: Must contain Practitioner or Organization references with valid Millennium IDs.
    Example: 
    {
  "performer": [
    {
      "reference": "Practitioner/3332064"
    }
  ]
}
  • presentedForm
    Rich-text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they shall be semantically equivalent.
    Note: Data and content type must be provided. The cardiology concept supports the contentType, data, url, title, and creation fields under presented forms. The anatomic pathology concept supports the contentType and data fields under present forms.
    Example: 
    {
  "presentedForm": {
         "contentType": "application/pdf;charset=utf-8",
         "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4=",
         "url": "http://snomed.info/sct"
         "title": "CT image",
         "creation": "2020-07-29T21:02:04.000Z"
       }
}
    {
  "presentedForm": {
         "contentType": "application/pdf;charset=utf-8",
         "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4="
       }
}
  • Identifies the type of 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.
    Note:
    • Must be provided.
    • Content type must include a supported MIME type and character set.
    • The following values are supported:
      • application/pdf
      • text/plain;charset=utf-8
      • text/richtext;charset=utf-8
      • text/rtf;charset=utf-8
      • text/html;charset=utf-8
      • application/xml;charset=utf-8
      • application/xhtml+xml;charset=utf-8
    Example: 
    {
  "contentType": "application/pdf;charset=utf-8"
}
  • The date when the attachment was first created.
    Note: A time component must be provided with the date.
    Example: 
    {
  "creation": "2020-07-29T21:02:04.000Z"
}
  • The actual data of the attachment as a sequence of bytes that is base64 encoded.
    Example: 
    {
  "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4="
}
  • A label or set of text to display in place of the data.
    Example: 
    {
  "title": "CT image",
}
  • A location where the data can be accessed.
    Example: 
    {
  "title": "http://snomed.info/sct",
}
  • Allowed Values: [ "DiagnosticReport" ]
    The type of the FHIR resource.
  • resultsInterpreter
    The practitioner or organization that is responsible for the report's conclusions and interpretations.
    Note:
    • Only the cardiology concept supports the resultsInterpreter field.
    • Must contain Practitioner or Organization references with valid Millennium IDs.
    • The API to create a cardiology diagnostic report requires a default user that is set up in the domain to chart a document. If no default user is defined in the domain, a results_interpreter attribute is mandatory to chart a cardiology document.
    Example: 
    {
  "resultsInterpreter": {
    "reference": "Practitioner/3332064"
  }
}
  • The status of the diagnostic report.
    Note: Must be one of the following statuses:
    • amended
    • cancelled
    • entered-in-error
    • final
    • partial
    • preliminary
    • registered
    • superseded
    • unknown
    Example: 
    {
  "status": "final"
}
  • subject
    The subject of the report. Usually, but not always, the subject is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
    Note: Only patient references are supported.
    Example: 
    {
  "subject": {
    "reference": "Patient/12457977"
  }
}
Nested Schema : basedOn
Type: object
Details concerning a service requested.
Note: Only the anatomic pathology concept supports the basedOn field. Must contain ServiceRequest references with valid Millennium IDs.
Example: 
{
  "basedOn": [
    {
        "reference": "ServiceRequest/99928073"
    }
  ]
}
Show Source
Nested Schema : category
Type: object
A code that classifies the clinical discipline, department, or diagnostic service that created the report (such as cardiology or anatomic pathology). This code is used for searching, sorting, and display purposes.
Note: The code must be LP29708-2 for a cardiology concept and LP7839-6 for an anatomic pathology concept.
Example: 
{
  "category": [
    {
        "coding": [
            {
                "code": "LP29708-2",
                "display": "Cardiology",
                "isUserSelected": false,
                "system": "http://loinc.org"
            }
        ],
        "text": "string"
    }
  ]
}
{
  "category": [
    {
        "coding": [
            {
                "code": "LP7839-6",
                "display": "Pathology study",
                "isUserSelected": false,
                "system": "http://loinc.org"
            }
        ],
        "text": "string"
    }
  ]
}
Show Source
Nested Schema : code
Type: object
Specifies the particular type of diagnostic report.
Note:
  • The code must include a LOINC or proprietary coding but not both together.
  • Multiple LOINC codings or a single proprietary coding can be provided.
  • When providing a proprietary code system, ensure that the format is https://fhir.cerner.com/[your EHR source ID]/codeSet/[code set], where the code set is Millennium Code Set 72. Example: 
    https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72
Example: 
{
  "code": {
    "coding": [
        {
            "code": "703535",
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
            "userSelected": true,
            "display": "Temperature Axillary"
        }
    ],
    "text": "Cardiology"
  }
}
{
  "code": {
    "coding": [
        {
            "code": "4187236",
            "system": "https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72",
            "userSelected": true,
            "display": "Anatomic Pathology"
        }
    ],
    "text": "Anatomic Pathology"
  }
}
Show Source
Nested Schema : effectivePeriod
Type: object
The time or time period that the observed values are related to. When the subject of the report is a patient, the effectivePeriod is usually the time of the procedure or specimen collection. The source of the date and time is often unknown, and only the date and time itself is known.
Note: Only the cardiology concept supports the effectivePeriod field.
Example: 
{
  "effectivePeriod": {
    "start": "2020-09-14T09:05:12.000Z",
    "end": "2020-09-14T09:05:12.000Z"
  }
}
Show Source
Nested Schema : encounter
Type: object
The healthcare event (such as a patient and healthcare provider interaction) that this diagnostic report is about.
Note: The encounter has to match the original document encounter.
Example: 
{
  "encounter": {
    "reference": "Encounter/98041577"
  }
}
Show Source
Nested Schema : identifier
Type: object
Identifiers assigned to this report by the performer or other systems.
Note:
  • The identifier for the cardiology concept must include the use, type, system, and value fields.
  • The type field would include coding.
  • coding internally would include code, system, version, display, and userSelected.
  • The identifier for the anatomic pathology concept must include the system and value fields.
Example: 
{
  "identifier": [
    {
        "use": "usual",
        "type": {
            "coding": [
                {
                    "code": "Coding",
                    "system": "http://snomed.info/sct",
                    "version": "4.0.1",
                    "display": "test",
                    "userSelected": true
                }
            ]
        },
        "system": "http://hl7.org/fhir/sid/us-ssn",
        "value": "11182456"
    }
  ]
}
{
  "identifier": [
    {
        "system": "https://fhir.cerner.com/ceuuid",
        "value": "CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-34824240-2022051205454801"
    }
  ]
}
Show Source
Nested Schema : meta
Type: object
The DiagnosticReport metadata.
Show Source
Nested Schema : performer
Type: object
The diagnostic service that is responsible for issuing the report.
Note: Must contain Practitioner or Organization references with valid Millennium IDs.
Example: 
{
  "performer": [
    {
      "reference": "Practitioner/3332064"
    }
  ]
}
Show Source
Nested Schema : presentedForm
Type: object
Rich-text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they shall be semantically equivalent.
Note: Data and content type must be provided. The cardiology concept supports the contentType, data, url, title, and creation fields under presented forms. The anatomic pathology concept supports the contentType and data fields under present forms.
Example: 
{
  "presentedForm": {
         "contentType": "application/pdf;charset=utf-8",
         "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4=",
         "url": "http://snomed.info/sct"
         "title": "CT image",
         "creation": "2020-07-29T21:02:04.000Z"
       }
}
{
  "presentedForm": {
         "contentType": "application/pdf;charset=utf-8",
         "data": "PGh0bWw+Cjx0aXRsZT4gVGVzdCBEb2N1bWVudCA8L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4="
       }
}
Show Source
  • Identifies the type of 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.
  • The date when the attachment was first created.
  • The actual data of the attachment as a sequence of bytes that is base64 encoded.
  • A label or set of text to display in place of the data.
Nested Schema : resultsInterpreter
Type: object
The practitioner or organization that is responsible for the report's conclusions and interpretations.
Note:
  • Only the cardiology concept supports the resultsInterpreter field.
  • Must contain Practitioner or Organization references with valid Millennium IDs.
  • The API to create a cardiology diagnostic report requires a default user that is set up in the domain to chart a document. If no default user is defined in the domain, a results_interpreter attribute is mandatory to chart a cardiology document.
Example: 
{
  "resultsInterpreter": {
    "reference": "Practitioner/3332064"
  }
}
Show Source
Nested Schema : subject
Type: object
The subject of the report. Usually, but not always, the subject is a patient. However, diagnostic services also perform analyses on specimens collected from a variety of other sources.
Note: Only patient references are supported.
Example: 
{
  "subject": {
    "reference": "Patient/12457977"
  }
}
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : assigner
Type: object
Show Source
Nested Schema : period
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : coding
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : security
Type: array
The DiagnosticReport confidentiality (only supported for Anatomic Pathology reports).
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

Example create request and reply for a cardiology diagnostic report.
Example Request: 
POST https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport
Example Request Body: 
{
    "resourceType": 'DiagnosticReport',
    "status": 'amended',
    "identifier": [
      {
        "use": 'usual',
        "type": {
          "coding": [
            {
              "code": 'Coding',
              "system": 'http://snomed.info/sct',
              "version": '4.0.1',
              "display": 'test',
              "userSelected": true
            }
          ]
        },
        "system": 'http://hl7.org/fhir/sid/us-ssn',
        "value": '11182457'
      }
    ],
    "category": [
      {
        "coding": [
          {
            "code": 'LP29708-2',
            "display": 'Cardiology',
            "isUserSelected": false,
            "system": 'http://loinc.org'
          }
        ],
        "text": 'string'
      }
    ],
    "code": {
      "coding": [
        {
          "system": 'http://loinc.org',
          "code": '8328-7'
        }
      ],
      "text": 'string'
    },
    "subject": {
      "reference": 'Patient/12804513'
    },
    "encounter": {
      "reference": 'Encounter/98041577'
    },
    "performer": [
      {
        "reference": 'Practitioner/11786042',
        "display": 'Practitioner name string'
      }
    ],
    "resultsInterpreter": [
      {
        "reference": 'Practitioner/11786042',
        "display": 'Practitioner name string'
      }
    ],
    "effectivePeriod": {
      "start": '2020-09-14T09:05:12.000Z',
      "end": '2020-09-14T09:05:12.000Z'
    },
    "issued": '2020-12-29T09:12:28Z',
    "presentedForm": [
      {
        "contentType": 'application/pdf;charset=utf-8',
        "url": 'http://snomed.info/sct',
        "data": 'JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9MZW5ndGggNiAwIF',
        "title": 'CT image',
        "creation": '2020-12-29T09:12:28Z'
      }
    ],
    "conclusion": 'conclusion string'
  }
Example Response: 
  Date: Mon, 09 Oct 2023 17:29:02 GMT
  Content-Type: text/html
  Connection: keep-alive
  Cache-Control: no-cache
  Etag: W/"1"
  Last-Modified: Mon, 09 Oct 2023 17:29:02 GMT
  Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197466617
  Referrer-Policy: strict-origin-when-cross-origin
  Server-Response-Time: 1288.314512
  Strict-Transport-Security: max-age=631152000
  Vary: Origin
  X-Content-Type-Options: nosniff
  X-Download-Options: noopen
  X-Frame-Options: SAMEORIGIN
  X-Permitted-Cross-Domain-Policies: none
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111
  X-Request-Id: 11111111-1111-1111-1111-111111111111
  X-Runtime: 1.288262
  X-Xss-Protection: 1; mode=block
  Transfer-Encoding: chunked
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

x-create-for-anatomic-pathology Response

Example create request and reply for an anatomic pathology diagnostic report.
Example Request: 
POST https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Provenance
Example Request Body: 
{
    "resourceType": 'DiagnosticReport',
    "meta": {
      "security": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "PHY"
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
          "code": "PRS"
        }
      ]
    },
    "status": 'amended',
    "identifier": [
      {
        "system": 'https://fhir.cerner.com/ceuuid',
        "value": 'CEfda49233-ccfa-4ed4-afbc-9f5082c2bf0c-34824240-2022051205454801'
      }
    ],
    "basedOn": [
      {
        "reference": 'ServiceRequest/99928073'
      }
    ],
    "category": [
      {
        "coding": [
          {
            "code": 'LP7839-6',
            "display": 'Pathology study',
            "isUserSelected": false,
            "system": 'http://loinc.org'
          }
        ],
        "text": 'string'
      }
    ],
    "code": {
      "coding": [
        {
          "code": '4187236',
          "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/72',
          "isUserSelected": true,
          "display": 'Anatomic Pathology'
        }
      ],
      "text": 'string'
    },
    "subject": {
      "reference": 'Patient/12804513'
    },
    "encounter": {
      "reference": 'Encounter/98041577'
    },
    "performer": [
      {
        "reference": 'Practitioner/11786042'
      }
    ],
    "effectiveDateTime": '2020-12-27T09:12:28Z',
    "issued": '2020-12-29T09:12:28Z',
    "presentedForm": [
      {
        "contentType": 'application/pdf;charset=utf-8',
        'data': 'PGh08L3RpdGxlPgoKRG9jdW1lbnQgY29udGVudCEKCjwvaHRtbD4='
      }
    ]
  }
Example Response: 
  Date: Mon, 09 Oct 2023 17:29:02 GMT
  Content-Type: text/html
  Connection: keep-alive
  Cache-Control: no-cache
  Etag: W/"1"
  Last-Modified: Mon, 09 Oct 2023 17:29:02 GMT
  Location: https://fhir-ehr.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/DiagnosticReport/197466627
  Referrer-Policy: strict-origin-when-cross-origin
  Server-Response-Time: 4626.253472
  Strict-Transport-Security: max-age=631152000
  Vary: Origin
  X-Content-Type-Options: nosniff
  X-Download-Options: noopen
  X-Frame-Options: SAMEORIGIN
  X-Permitted-Cross-Domain-Policies: none
  opc-request-id: /11111111111111111111111111111111/11111111111111111111111111111111
  X-Request-Id: 11111111-1111-1111-1111-111111111111
  X-Runtime: 4.626156
  X-Xss-Protection: 1; mode=block
  Transfer-Encoding: chunked
The ETag response header indicates the current If-Match version to use on a subsequent update.
Headers
  • For Update or Patch versioning controls. Related to If-Match. When a resource performs an operation that creates or updates a record, an Etag value is returned as a header. This same value should be included in request headers as an If-Match for any subsequent update to that record.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top