Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html

Endpoints

get
/Organization/{id}
 get
/Organization

Attributes

id
string

The identifier of the Organization

identifier
array[json]

Identifies this organization across multiple systems.

When relevant, group NPI values will be found here. Other identifiers, such as insurance payor values, are not yet supported.

active
boolean

Whether the organization’s record is still in active use

name
string

Name used for the organization

telecom
array[json]

A contact detail for the organization

address
array[json]

An address for the organization

get
/Organization/{id}

Organization read

Read an Organization resource.

Path Parameters

id required
string
The unique identifier for the Organization

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/Organization

Organization search

Search for Organization resources.

Query Parameters

_id
string

The identifier of the Organization

address
string

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

name
string

A portion of the organization’s name or alias

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Organization/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Organization/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Organization",
    "id": "bcf685dd-f71e-49da-b471-1ee322a8d9f4",
    "identifier": [
        {
            "system": "http://hl7.org.fhir/sid/us-npi",
            "value": "1144221847"
        }
    ],
    "active": true,
    "name": "Acme Labs",
    "telecom": [
        {
            "system": "fax",
            "value": "5558675310",
            "use": "work"
        },
        {
            "system": "phone",
            "value": "5558675309",
            "use": "work"
        },
        {
            "system": "email",
            "value": "hq@acme.org",
            "use": "work"
        }
    ],
    "address": [
        {
            "use": "work",
            "type": "both",
            "line": [
                "3300 Washtenaw Avenue, Suite 227"
            ],
            "city": "Amherst",
            "state": "MA",
            "postalCode": "01002",
            "country": "USA"
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Unknown Organization resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Organization?name=acme' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Organization?name=acme"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "/Organization?name=acme&_count=10&_offset=0"
        },
        {
            "relation": "first",
            "url": "/Organization?name=acme&_count=10&_offset=0"
        },
        {
            "relation": "last",
            "url": "/Organization?name=acme&_count=10&_offset=0"
        }
    ],
    "entry": [
        {
            "resource": {
                "resourceType": "Organization",
                "id": "bcf685dd-f71e-49da-b471-1ee322a8d9f4",
                "identifier": [
                    {
                        "system": "http://hl7.org.fhir/sid/us-npi",
                        "value": "1144221847"
                    }
                ],
                "active": true,
                "name": "Acme Labs",
                "telecom": [
                    {
                        "system": "fax",
                        "value": "5558675310",
                        "use": "work"
                    },
                    {
                        "system": "phone",
                        "value": "5558675309",
                        "use": "work"
                    },
                    {
                        "system": "email",
                        "value": "hq@acme.org",
                        "use": "work"
                    }
                ],
                "address": [
                    {
                        "use": "work",
                        "type": "both",
                        "line": [
                            "3300 Washtenaw Avenue, Suite 227"
                        ],
                        "city": "Amherst",
                        "state": "MA",
                        "postalCode": "01002",
                        "country": "USA"
                    }
                ]
            }
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Bad request"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}