To define

Supported Formats

json

GET /AllergyIntolerance
Allergies Bundle

Supported Formats

json

Errors

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

Examples

GET /AllergyIntolerance?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "a74e9658ae58a4d16e9f13d9fc3ba16a",
  "type": "search set",
  "entry": [
    {
      "full_url": "/AllergyIntolerance/",
      "resource": {
        "resourceType": "AllergyIntolerance",
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "247472004",
              "display": "Hives"
            }
          ],
          "text": "Hives"
        },
        "reaction": [
          {
            "manifestation": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "247472004",
                    "display": "Hives"
                  }
                ],
                "text": "Hives"
              }
            ],
            "severity": "moderate"
          }
        ],
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "unconfirmed"
            }
          ]
        },
        "patient": {
          "display": "Alice, Newman",
          "reference": "Patient/1"
        }
      }
    },
    {
      "full_url": "/AllergyIntolerance/",
      "resource": {
        "resourceType": "AllergyIntolerance",
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "247472004",
              "display": "Hives"
            }
          ],
          "text": "Hives"
        },
        "reaction": [
          {
            "manifestation": [
              {
                "coding": [
                  {
                    "system": "http://snomed.info/sct",
                    "code": "247472004",
                    "display": "Hives"
                  }
                ],
                "text": "Hives"
              }
            ],
            "severity": "moderate"
          }
        ],
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
              "code": "active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
              "code": "unconfirmed"
            }
          ]
        },
        "patient": {
          "display": "Alice, Newman",
          "reference": "Patient/1"
        }
      }
    }
  ],
  "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.


GET /AllergyIntolerance/:id
Allergies by id

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.

id
optional

ID of requested Allergy

Validations:

  • Must be number.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

AllergyIntolerance

Validations:

  • Must be String.

code
required

Validations:

  • Must be Hash.

reaction
required

Validations:

  • Must be Array.

clinical_status
required

Validations:

  • Must be Hash.

verification_status
required

Validations:

  • Must be Hash.

patient
required

Validations:

  • Must be Hash.


GET /AllergyIntolerance/_search
Allergy search