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
Attributes
The identifier of the Organization
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.
Whether the organization’s record is still in active use
Name used for the organization
A contact detail for the organization
An address for the organization
Organization read
Read an Organization resource.
Path Parameters
Responses
Errors
Organization search
Search for Organization resources.
Query Parameters
The identifier of the Organization
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
A portion of the organization’s name or alias
Responses
Errors
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" } } ] }