POST /api/DiagnosticReport/_search
Diagnostic Reports by POST

GET /api/DiagnosticReport/:id
Diagnostic Report by ID

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /DiagnosticReport/1001
401
GET /DiagnosticReport/1001?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "DiagnosticReport",
  "id": "1001",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": null,
          "display": null
        }
      ],
      "text": null
    }
  ],
  "encounter": {
    "reference": "Encounter/"
  },
  "presentedForm": [
    {
      "contentType": "application/html",
      "url": "/DocumentReference/"
    }
  ],
  "status": "unknown",
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "24357-6",
        "display": "Urinalysis macro (dipstick) panel - Urine"
      }
    ]
  },
  "subject": {
    "reference": "Patient/1"
  },
  "effectiveDateTime": "2015-06-22",
  "issued": {
    "valueQuantity": {
      "extension": {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    },
    "dataAbsentReason": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
          "code": "unknown",
          "display": "Unknown"
        }
      ],
      "text": "Unknown"
    }
  },
  "performer": [
    {
      "reference": "Practitioner/",
      "display": "Albert Davis"
    }
  ],
  "result": [
    {
      "reference": "Observation/",
      "display": "Color of Urine"
    },
    {
      "reference": "Observation/",
      "display": "Appearance of Urine"
    },
    {
      "reference": "Observation/",
      "display": "Specific gravity of Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "pH of Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Glucose [Mass/volume] in Urineby Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Ketones [Mass/volume] in Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Protein [Mass/volume] in Urine by Test strip"
    }
  ]
}
GET /DiagnosticReport/1001?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "DiagnosticReport",
  "id": "1001",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": null,
          "display": null
        }
      ],
      "text": null
    }
  ],
  "encounter": {
    "reference": "Encounter/"
  },
  "presentedForm": [
    {
      "contentType": "application/html",
      "url": "/DocumentReference/"
    }
  ],
  "status": "unknown",
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "24357-6",
        "display": "Urinalysis macro (dipstick) panel - Urine"
      }
    ]
  },
  "subject": {
    "reference": "Patient/1"
  },
  "effectiveDateTime": "2015-06-22",
  "issued": {
    "valueQuantity": {
      "extension": {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    },
    "dataAbsentReason": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
          "code": "unknown",
          "display": "Unknown"
        }
      ],
      "text": "Unknown"
    }
  },
  "performer": [
    {
      "reference": "Practitioner/",
      "display": "Albert Davis"
    }
  ],
  "result": [
    {
      "reference": "Observation/",
      "display": "Color of Urine"
    },
    {
      "reference": "Observation/",
      "display": "Appearance of Urine"
    },
    {
      "reference": "Observation/",
      "display": "Specific gravity of Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "pH of Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Glucose [Mass/volume] in Urineby Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Ketones [Mass/volume] in Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Protein [Mass/volume] in Urine by Test strip"
    }
  ]
}
GET /DiagnosticReport/1001?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "DiagnosticReport",
  "id": "1001",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://loinc.org",
          "code": null,
          "display": null
        }
      ],
      "text": null
    }
  ],
  "encounter": {
    "reference": "Encounter/"
  },
  "presentedForm": [
    {
      "contentType": "application/html",
      "url": "/DocumentReference/"
    }
  ],
  "status": "unknown",
  "code": {
    "coding": [
      {
        "system": "http://loinc.org",
        "code": "24357-6",
        "display": "Urinalysis macro (dipstick) panel - Urine"
      }
    ]
  },
  "subject": {
    "reference": "Patient/1"
  },
  "effectiveDateTime": "2015-06-22",
  "issued": {
    "valueQuantity": {
      "extension": {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    },
    "dataAbsentReason": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
          "code": "unknown",
          "display": "Unknown"
        }
      ],
      "text": "Unknown"
    }
  },
  "performer": [
    {
      "reference": "Practitioner/",
      "display": "Albert Davis"
    }
  ],
  "result": [
    {
      "reference": "Observation/",
      "display": "Color of Urine"
    },
    {
      "reference": "Observation/",
      "display": "Appearance of Urine"
    },
    {
      "reference": "Observation/",
      "display": "Specific gravity of Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "pH of Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Glucose [Mass/volume] in Urineby Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Ketones [Mass/volume] in Urine by Test strip"
    },
    {
      "reference": "Observation/",
      "display": "Protein [Mass/volume] in Urine by Test strip"
    }
  ]
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
id
optional

ID of requested Diagnostic Report

Validations:

  • Must be number.
patient
optional

ID of the requested patient

Validations:

  • Must be number.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

DiagnosticReport

Validations:

  • Must be String.
status
required

Validations:

  • Must be String.
code
required

Validations:

  • Must be Hash.
subject
required

Validations:

  • Must be Hash.
effective_date_time
required

Validations:

  • Must be String.
issued
required

Validations:

  • Must be String.
performer
required

Validations:

  • Must be Array.
result
required

Validations:

  • Must be Array.