Diagnostic_reports

To define

Supported Formats

json
>>>

GET /api/DiagnosticReport
Diagnostic Reports

Supported Formats

json

Errors

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

Examples

GET /DiagnosticReport?patient=1&code=24357-6&category=LP29708-2&date=ge2015-06-21T00%3A00%3A00%2B00%3A00&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "654b279873d8c72c586ad3770c8c2d63",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/DiagnosticReport/",
      "resource": {
        "resourceType": "DiagnosticReport",
        "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": null,
              "display": null
            }
          ]
        },
        "subject": {
          "reference": "Patient/1"
        },
        "effectiveDateTime": {
          "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"
          }
        },
        "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"
          }
        ]
      }
    }
  ],
  "total": 1
}
GET /DiagnosticReport?patient=1&code=24357-6&category=LP29708-2&date=ge2015-06-21T00%3A00%3A00%2B00%3A00&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "e107bc1dffd4862fdeb09443bb847900",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/DiagnosticReport/",
      "resource": {
        "resourceType": "DiagnosticReport",
        "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": null,
              "display": null
            }
          ]
        },
        "subject": {
          "reference": "Patient/1"
        },
        "effectiveDateTime": {
          "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"
          }
        },
        "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"
          }
        ]
      }
    }
  ],
  "total": 1
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
code
optional

LOINC code of requested Diagnostic Report i.e. 24323-8 or loinc.org|24323-8

Validations:

  • Must be string.
category
optional

Category of Diagnostic Report i.e. lab

Validations:

  • Must be string.
date
optional

Date of Diagnostic Report with optional prefix in the form of two letters i.e. lt/gt/le/ge

Validations:

  • Must be string.
patient
optional

ID of the requested patient

Validations:

  • Must be number.
start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.
end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Bundle

Validations:

  • Must be String.
type
required

Validations:

  • Must be String.
>>>

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.