GET /api/Organization/:id
Organization by ID

Supported Formats

json

Errors

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

Examples

GET /Organization/1007
401
GET /Organization/1007?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    }
  ]
}
GET /Organization/1007?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    }
  ]
}
GET /Organization/1007?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "2016-02-27"
      }
    }
  ]
}

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

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.