Practitioner

Supported Formats

json

Errors

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

Examples

GET /Practitioner?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "1f2ac49a870c0805fffb930157f3a308",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Practitioner/1013",
      "resource": {
        "resourceType": "Practitioner",
        "id": "1013",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
          ]
        },
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": ""
          }
        ],
        "name": [
          {
            "family": "Staff",
            "given": [
              "Superviser"
            ]
          }
        ],
        "telecom": [
          {
            "system": "email",
            "value": "superviserstaff@test.com",
            "use": "work"
          }
        ],
        "address": [
          {
            "line": [
              "123 fake street"
            ],
            "postalCode": "55555",
            "city": "springfield",
            "state": null,
            "country": "US",
            "period": {
              "start": "2012-12-13"
            }
          }
        ]
      }
    }
  ],
  "total": 1
}

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 /Practitioner/1013?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Practitioner",
  "id": "1013",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
    ]
  },
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": ""
    }
  ],
  "name": [
    {
      "family": "Staff",
      "given": [
        "Superviser"
      ]
    }
  ],
  "telecom": [
    {
      "system": "email",
      "value": "superviserstaff@test.com",
      "use": "work"
    }
  ],
  "address": [
    {
      "line": [
        "123 fake street"
      ],
      "postalCode": "55555",
      "city": "springfield",
      "state": null,
      "country": "US",
      "period": {
        "start": "2012-12-13"
      }
    }
  ]
}

Params

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

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Practitioner Validations: Must be String.
identifier required	Validations: Must be Array.
name required	Validations: Must be Array.
telecom required	Validations: Must be ContactInfo.
address required	Validations: Must be Address.

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.