---
title: "Organization"
canonical: "https://wiki.patientsknowbest.com/space/api/3364618449/Organization"
format: markdown
---
[https://www.hl7.org/fhir/STU3/organization.html](https://www.hl7.org/fhir/STU3/organization.html)

## Status

Search interaction added to roadmap. API subject to change.

- a search interaction will be added to the Organization resource to allow a System User to retrieve [[Team]]'s that are partOf an [[Organisation]]. The use case for this will be to support the [$invite-team-member](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364421746) and[ ](https://dev.patientsknowbest.com/home/fhir-apis/facade/roadmap/deactivate-team-member)[$deactivate-team-member](https://wiki.hub.patientsknowbest.com/wiki/spaces/api/pages/3364618430) operations.

## Endpoints

|  |  |  |  |  |  |
| --- | --- | --- | --- | --- | --- |
| Interaction | HTTP | URL | Supported Parameters | Permitted User Types | Description |
| [search](https://www.hl7.org/fhir/STU3/http.html#search) | GET | /Organization/ | name <optional>,<br>partOf <mandatory> | - System | Return [[Team]]'s that are  *partOf*  [[Organisation]]<br>*name*  can be optionally included to find a specific [[Team]] by a portion of that teams name.<br>Returns a  searchset [bundle](https://www.hl7.org/fhir/bundle.html) of Organization resources<br>- id - [[Team.Public ID]]
- name - [[Team.name]]
- partOf -  Reference   
reference = the relative URL of the Organization resource.   
display = [[Organisation.Name]] |

Examples

Find all [[Team]]'s that are partOf Org A

<u>Request</u>

/Organization/?partOf=Organization/<Org A UUID>

<u>Response</u>

{

"resourceType": "Bundle",

"type": "searchset",

"total": "2",

"link": [

{

"relation": "self",

"url": "/Organization?partOf=Organization/<Org A UUID>"

}

],

"entry":

[

{

"fullUrl": "https://sandbox.patientsknowbest.com/fhir/Organization/>",

"resourceType": "Organization",

"id": "<team-UUID>",

"name": "Oncology Team",

"partOf":

{

"reference": "Organization/<Org A UUID>", "display": "Org A"

},

"search": { "mode": "match" }

},

{

"fullUrl": "https://sandbox.patientsknowbest.com/fhir/Organization/>",

"resourceType": "Organization",

"id": "<team-UUID>",

"name": "Thyroid Team",

"partOf":

{

"reference": "Organization/<Org A UUID>", "display": "Org A"

},

"search": { "mode": "match" }

}

]

}

Find all [[Team]]'s that are partOf Org A and have 'Oncology' in the name

<u>Request</u>

/Organization/?partOf=Organization/<Org A UUID>?name=Oncology

<u>Response</u>

{

"resourceType": "Bundle",

"type": "searchset",

"total": "1",

"link": [

{

"relation": "self",

"url": "/Organization?partOf=Organization/<Org A UUID>?name=Oncology"

}

],

"entry":

[

{

"fullUrl": "https://sandbox.patientsknowbest.com/fhir/Organization/>",

"resourceType": "Organization",

"id": "<team-UUID>",

"name": "Oncology Team",

"partOf":

{

"reference": "Organization/<Org A UUID>", "display": "Org A"

},

"search": { "mode": "match" }

}

]

}