Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 and$deactivate-team-member operations.

Endpoints

Interaction

HTTP

URL

Supported Parameters

Permitted User Types

Description

search

GET

/Organization/

name <optional>,

partOf <mandatory>

  • System

Return [[Team]]'s that are  partOf  [[Organisation]]

name  can be optionally included to find a specific [[Team]] by a portion of that teams name.

Returns a  searchset   bundle  of of Organization resources

  • 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

...

}

],

"entry":

[

{

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

"resourceType": "Organization",

...

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

},

{

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

"resourceType": "Organization",

...

}

],

"entry":

[

{

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

"resourceType": "Organization",

...