Immunizations

Supported Formats

json

Errors

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

Examples

GET /Immunization?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "fedef77c2d48ab3bd9f96b72cff997ae",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Immunization/",
      "resource": {
        "resourceType": "Immunization",
        "occurrenceDateTime": "2015-06-22T00:00:00-04:00",
        "status": "not-done",
        "statusReason": {
          "text": "Test"
        },
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "166",
              "display": "influenza, intradermal, quadrivalent, preservative free, injectable"
            }
          ],
          "text": "influenza, intradermal, quadrivalent, preservative free, injectable"
        },
        "patient": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        },
        "primarySource": false
      }
    },
    {
      "full_url": "/Immunization/",
      "resource": {
        "resourceType": "Immunization",
        "occurrenceDateTime": "2012-01-04T00:00:00-05:00",
        "status": "completed",
        "statusReason": {
          "text": "Test"
        },
        "vaccineCode": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/sid/cvx",
              "code": "106",
              "display": "diptheria, tetanus toxoids and acellular perstussis vaccine, 5 pertussis antigens"
            }
          ],
          "text": "diptheria, tetanus toxoids and acellular perstussis vaccine, 5 pertussis antigens"
        },
        "patient": {
          "reference": "Patient/1",
          "display": "Alice, Newman"
        },
        "primarySource": false
      }
    }
  ],
  "total": 2
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token 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.

Supported Formats

json

Errors

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

Examples

GET /Immunization/1001?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Immunization",
  "id": "1001",
  "occurrenceDateTime": "2012-01-03T23:00:00.000-05:00",
  "status": "completed",
  "statusReason": {
    "text": "Test"
  },
  "vaccineCode": {
    "coding": [
      {
        "system": "http://hl7.org/fhir/sid/cvx",
        "code": "106",
        "display": "diptheria, tetanus toxoids and acellular perstussis vaccine, 5 pertussis antigens"
      }
    ],
    "text": "diptheria, tetanus toxoids and acellular perstussis vaccine, 5 pertussis antigens"
  },
  "patient": {
    "reference": "Patient/1",
    "display": "Newman, Alice, Jones, Alicia, "
  },
  "primarySource": false
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
id optional	ID of requested immunization Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Immunization Validations: Must be String.
occurrenceDateTime required	Validations: Must be String.
status required	Validations: Must be String.
status_reason required	Validations: Must be Hash.
vaccine_code required	Validations: Must be Hash.
patient required	Validations: Must be Hash.
primary_source required	Validations: Must be Boolean.

Supported Formats

json

Errors

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

Params

Param name	Description
access_token required	CarePaths User OAuth Token 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.