Considerations

Verbs

Verb Meaning
GET Read the resource

Future versions of the Allscripts FHIR API will support create and update.

Http response codes

Code Meaning
200 The request was processed appropriately.
400 Invalid parameter.
401 The request did not have a valid authorization token or none was provided. Obtain a valid authorization token and add it to the authorization header.
403 The user is not authorized for the operation. The user may not have access to the patient, or an invalid scope was provided.
4xx Authorization error.

Additional error information

A response with a code in the 4xx or 5xx may contain addtional information in the form of a FHIR OperationOutcome.

For example:

{
  "resourceType": "OperationOutcome",
  "id": "101",
  "text": {
    "status": "additional",
    "div": "<div>\n      <p>W is not a recognized code for Gender.</p>\n    </div>"
  },
  "issue": [
    {
      "severity": "error",
      "code": "code-invalid",
      "details": {
        "text": "The code \"W\" is not known and not legal in this context"
      },
      "diagnostics": "Acme.Interop.FHIRProcessors.Patient.processGender line 2453",
      "location": [
        "/f:Person/f:gender"
      ]
    }
  ]
}