Jump to

• Request
• Response

Get a list of diagnostic reports

get

/DiagnosticReport

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of diagnostic reports that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• category: string
  A code that classifies the clinical discipline, department, or diagnostic service that created the report.
• code: string
  The test, panel, report, or note that was ordered.
• date: string
  The diagnostically relevant time or time period that the report is related to.
• patient: string
  The subject of the report. Usually, but not always, the subject is a patient.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/DiagnosticReport"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/DiagnosticReport"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object DiagnosticReport
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/DiagnosticReport"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : DiagnosticReport

Type: object

Show Source

• category(required): array category

  (USCDI) The service category.

  • For Diagnostic Report Lab, the category includes the Laboratory slice and LAB code from http://terminology.hl7.org/CodeSystem/v2-0074.
  • For Diagnostic Report Note, the category includes values conforming to the U.S. Core DiagnosticReport category slice.
• code(required): code
  (USCDI) The test, panel, report, or note that was ordered.
• conclusion: string
  The clinical conclusion (interpretation) of the test results.
• effectiveDateTime: string (date-time)
  (USCDI) The diagnostically relevant time that the report is related to.
• effectivePeriod: effectivePeriod
  (USCDI) The diagnostically relevant time period that the report is related to.
• encounter: encounter
  (USCDI) The healthcare event that this diagnostic report is about.
• id(required): string
• issued: string (date-time)
  (USCDI) The date and time when this version of the report was made available.
• media: array media
  (USCDI) The key images that are associated with this report.
• performer: array performer
  (USCDI) The diagnostic service that is responsible for issuing the report.
• presentedForm: array presentedForm
  (USCDI) The rich-text representation of the entire result as issued by the diagnostic service.
• resourceType(required): string
  Allowed Values: [ "DiagnosticReport" ]
• result: array result
  (USCDI) The observations that are part of this diagnostic report.
• status(required): string
  (USCDI) The status of the diagnostic report.
• subject(required): subject
  (USCDI) The subject of the report. Usually, but not always, the subject is the patient.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "category",
        "code",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "DiagnosticReport"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The status of the diagnostic report."
        },
        "category":{
            "type":"array",
            "description":"<p>(USCDI) The service category.</p>\n<ul>\n  <li>For Diagnostic Report Lab, the category includes the Laboratory slice and <code>LAB</code> code from <code>http://terminology.hl7.org/CodeSystem/v2-0074</code>.</li>\n  <li>For Diagnostic Report Note, the category includes values conforming to the U.S. Core DiagnosticReport category slice.</li>\n</ul>\n",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "code":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The test, panel, report, or note that was ordered."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The subject of the report. Usually, but not always, the subject is the patient."
        },
        "encounter":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The healthcare event that this diagnostic report is about."
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The diagnostically relevant time that the report is related to."
        },
        "effectivePeriod":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Period"
                }
            ],
            "description":"(USCDI) The diagnostically relevant time period that the report is related to."
        },
        "issued":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The date and time when this version of the report was made available."
        },
        "performer":{
            "type":"array",
            "description":"(USCDI) The diagnostic service that is responsible for issuing the report.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "result":{
            "type":"array",
            "description":"(USCDI) The observations that are part of this diagnostic report.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "media":{
            "type":"array",
            "description":"(USCDI) The key images that are associated with this report.",
            "items":{
                "$ref":"#/components/schemas/DiagnosticReportMedia"
            }
        },
        "conclusion":{
            "type":"string",
            "description":"The clinical conclusion (interpretation) of the test results."
        },
        "presentedForm":{
            "type":"array",
            "description":"(USCDI) The rich-text representation of the entire result as issued by the diagnostic service.",
            "items":{
                "$ref":"#/components/schemas/Attachment"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : category

Type: array

(USCDI) The service category.

• For Diagnostic Report Lab, the category includes the Laboratory slice and LAB code from http://terminology.hl7.org/CodeSystem/v2-0074.
• For Diagnostic Report Note, the category includes values conforming to the U.S. Core DiagnosticReport category slice.

Show Source

• Array of: object CodeableConcept

{
    "type":"array",
    "description":"<p>(USCDI) The service category.</p>\n<ul>\n  <li>For Diagnostic Report Lab, the category includes the Laboratory slice and <code>LAB</code> code from <code>http://terminology.hl7.org/CodeSystem/v2-0074</code>.</li>\n  <li>For Diagnostic Report Note, the category includes values conforming to the U.S. Core DiagnosticReport category slice.</li>\n</ul>\n",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : code

(USCDI) The test, panel, report, or note that was ordered.

Match All

(USCDI) The test, panel, report, or note that was ordered.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The test, panel, report, or note that was ordered."
}

Nested Schema : effectivePeriod

(USCDI) The diagnostically relevant time period that the report is related to.

Match All

(USCDI) The diagnostically relevant time period that the report is related to.

Show Source

• object Period

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Period"
        }
    ],
    "description":"(USCDI) The diagnostically relevant time period that the report is related to."
}

Nested Schema : encounter

(USCDI) The healthcare event that this diagnostic report is about.

Match All

(USCDI) The healthcare event that this diagnostic report is about.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The healthcare event that this diagnostic report is about."
}

Nested Schema : media

Type: array

(USCDI) The key images that are associated with this report.

Show Source

• Array of: object DiagnosticReportMedia

{
    "type":"array",
    "description":"(USCDI) The key images that are associated with this report.",
    "items":{
        "$ref":"#/components/schemas/DiagnosticReportMedia"
    }
}

Nested Schema : performer

Type: array

(USCDI) The diagnostic service that is responsible for issuing the report.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The diagnostic service that is responsible for issuing the report.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : presentedForm

Type: array

(USCDI) The rich-text representation of the entire result as issued by the diagnostic service.

Show Source

• Array of: object Attachment

{
    "type":"array",
    "description":"(USCDI) The rich-text representation of the entire result as issued by the diagnostic service.",
    "items":{
        "$ref":"#/components/schemas/Attachment"
    }
}

Nested Schema : result

Type: array

(USCDI) The observations that are part of this diagnostic report.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The observations that are part of this diagnostic report.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : subject

(USCDI) The subject of the report. Usually, but not always, the subject is the patient.

Match All

(USCDI) The subject of the report. Usually, but not always, the subject is the patient.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The subject of the report. Usually, but not always, the subject is the patient."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string (date-time)
• start: string (date-time)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "format":"date-time"
        },
        "end":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : DiagnosticReportMedia

Type: object

Show Source

• link(required): link
  (USCDI) A reference to the image source.

{
    "type":"object",
    "required":[
        "link"
    ],
    "properties":{
        "link":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) A reference to the image source."
        }
    }
}

Nested Schema : link

(USCDI) A reference to the image source.

Match All

(USCDI) A reference to the image source.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) A reference to the image source."
}

Nested Schema : Attachment

Type: object

Show Source

• contentType: string
• data: string
• url: string (uri)

{
    "type":"object",
    "properties":{
        "contentType":{
            "type":"string"
        },
        "data":{
            "type":"string"
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top