Plan_of_treatments

To define

Supported Formats

json
>>>

GET /api/CarePlan
Care Plans

Supported Formats

json

Errors

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

Examples

GET /CarePlan?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "c41c39e6efd851dbe573d097246cd041",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/CarePlan/2",
      "resource": {
        "resourceType": "CarePlan",
        "id": "2",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
        },
        "status": "unknown",
        "intent": "proposal",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": " "
        }
      }
    }
  ],
  "total": 1
}
GET /CarePlan?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "16db0e4f64c9ac5d32f94187d083a3b1",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/CarePlan/2",
      "resource": {
        "resourceType": "CarePlan",
        "id": "2",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
        },
        "status": "unknown",
        "intent": "proposal",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": " "
        }
      }
    }
  ],
  "total": 1
}
GET /CarePlan?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "bd8ad64a3a4fe5962e47c4f918fecb68",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/CarePlan/2",
      "resource": {
        "resourceType": "CarePlan",
        "id": "2",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
          ]
        },
        "text": {
          "status": "generated",
          "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
        },
        "status": "unknown",
        "intent": "proposal",
        "category": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
                "code": "assess-plan"
              }
            ]
          }
        ],
        "subject": {
          "reference": "Patient/1",
          "display": " "
        }
      }
    }
  ],
  "total": 1
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
category
optional

Category such as 'assess-plan'

Validations:

  • Must be string.
patient
optional

Patient ID

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

CarePlan

Validations:

  • Must be String.
text
required

Validations:

  • Must be Hash.
status
required

Validations:

  • Must be String.
intent
required

Validations:

  • Must be String.
category
required

Validations:

  • Must be Array.
subject
required

Validations:

  • Must be Hash.
>>>

POST /api/CarePlan/_search
Care Plans by POST

GET /api/CarePlan/:id
Care Plan by ID

Supported Formats

json

Errors

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

Examples

GET /CarePlan/2?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "CarePlan",
  "id": "2",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
  },
  "status": "unknown",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/1",
    "display": " "
  }
}
GET /CarePlan/2?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "CarePlan",
  "id": "2",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
  },
  "status": "unknown",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/1",
    "display": " "
  }
}
GET /CarePlan/2?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "CarePlan",
  "id": "2",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
  },
  "status": "unknown",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/1",
    "display": " "
  }
}
GET /CarePlan/2?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "CarePlan",
  "id": "2",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Test Instrux</div>"
  },
  "status": "unknown",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
          "code": "assess-plan"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/1",
    "display": " "
  }
}
GET /CarePlan/2
401

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

CarePlan

Validations:

  • Must be String.
text
required

Validations:

  • Must be Hash.
status
required

Validations:

  • Must be String.
intent
required

Validations:

  • Must be String.
category
required

Validations:

  • Must be Array.
subject
required

Validations:

  • Must be Hash.