Organization

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 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

Request


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


Response


{ 

    "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

Request


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


Response


{ 

    "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" } 

        }

    ]

}



Comments