Organization

Supported Formats

json

Errors

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

Examples

GET /Organization?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "378d85870c9cfabe23a81ee1f23c06d9",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Organization/1007",
      "resource": {
        "resourceType": "Organization",
        "id": "1007",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
          ]
        },
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "123456789"
          }
        ],
        "active": true,
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                "code": "prov",
                "display": "Healthcare Provider"
              }
            ]
          }
        ],
        "name": "Neighborhood Physicians Practice",
        "telecom": [
          {
            "system": "phone",
            "value": "5555551002"
          },
          {
            "system": "email",
            "value": "albertdavis@test.com"
          }
        ],
        "address": [
          {
            "line": [
              "2472, Rocky place"
            ],
            "postalCode": "97006",
            "city": "Beaverton",
            "state": "OR",
            "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 /Organization/1007?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Organization",
  "id": "1007",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
    ]
  },
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "123456789"
    }
  ],
  "active": true,
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/organization-type",
          "code": "prov",
          "display": "Healthcare Provider"
        }
      ]
    }
  ],
  "name": "Neighborhood Physicians Practice",
  "telecom": [
    {
      "system": "phone",
      "value": "5555551002"
    },
    {
      "system": "email",
      "value": "albertdavis@test.com"
    }
  ],
  "address": [
    {
      "line": [
        "2472, Rocky place"
      ],
      "postalCode": "97006",
      "city": "Beaverton",
      "state": "OR",
      "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 Organization Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Organization Validations: Must be String.
identifier required	Validations: Must be Array.
active required	Validations: Must be String.
type required	Validations: Must be Array.
name required	Validations: Must be String.
telecom required	Validations: Must be Array.
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.