# text.div
organization

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's data using a fulltext search

# rest[].resource[].searchParam[].documentation
Return resources linked to by the given target

# rest[].resource[].searchParam[].documentation
Only return resources which were last updated as specified by the given range

# rest[].resource[].searchParam[].documentation
Search for resources which have the given profile

# rest[].resource[].searchParam[].documentation
Search for resources which have the given security labels

# rest[].resource[].searchParam[].documentation
Search for resources which have the given tag

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's narrative using a fulltext search

# rest[].resource[].searchParam[].documentation
A type of use context assigned to the care team

# rest[].resource[].searchParam[].documentation
A use context type and value assigned to the care team

# rest[].resource[].searchParam[].documentation
Encounter or episode associated with CareTeam

# rest[].resource[].searchParam[].documentation
proposed | active | suspended | inactive | entered-in-error

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's data using a fulltext search

# rest[].resource[].searchParam[].documentation
Return resources linked to by the given target

# rest[].resource[].searchParam[].documentation
Only return resources which were last updated as specified by the given range

# rest[].resource[].searchParam[].documentation
Search for resources which have the given profile

# rest[].resource[].searchParam[].documentation
Search for resources which have the given security labels

# rest[].resource[].searchParam[].documentation
Search for resources which have the given tag

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's narrative using a fulltext search

# rest[].resource[].searchParam[].documentation
A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

# rest[].resource[].searchParam[].documentation
A (part of the) address of the organization

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to services operated for the organization

# rest[].resource[].searchParam[].documentation
Any identifier for the organization (not the accreditation issuer's identifier)

# rest[].resource[].searchParam[].documentation
A portion of the organization's name or alias

# rest[].resource[].searchParam[].documentation
An organization of which this organization forms a part

# rest[].resource[].searchParam[].documentation
A portion of the organization's name using some kind of phonetic matching algorithm

# rest[].resource[].operation[].documentation
The operation resolves the input organization(s) to the shared organization for the one or more organizations that have the given provider number. 
The Organization returned depends on how many active Organization exist in the service with that provider number. When a single Organization has the provider number that Organization is returned. 
When multiple Organization resources have the same provider number, the shared parent Organization is returned. 
An OperationOutcome with an explicit error is returned in case multiple organizations share the provider number but do not have a shared parent, or in case input organizations have different provider numbers. 
A typical use of the operation is to get name, address and telecom details for a general practitioner. Many provider numbers are assigned to a single organization but some provider numbers are shared by multiple entities (organizations) within in a common practice.

# rest[].resource[].operation[].documentation
Traverse upforwards to the first SOR organization
Http response code 404 will be returned if no related SOR organization could be found

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's data using a fulltext search

# rest[].resource[].searchParam[].documentation
Return resources linked to by the given target

# rest[].resource[].searchParam[].documentation
Only return resources which were last updated as specified by the given range

# rest[].resource[].searchParam[].documentation
Search for resources which have the given profile

# rest[].resource[].searchParam[].documentation
Search for resources which have the given security labels

# rest[].resource[].searchParam[].documentation
Search for resources which have the given tag

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's narrative using a fulltext search

# rest[].resource[].searchParam[].documentation
Whether the practitioner record is active

# rest[].resource[].searchParam[].documentation
A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text

# rest[].resource[].searchParam[].documentation
One of the languages that the practitioner can communicate with

# rest[].resource[].searchParam[].documentation
A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

# rest[].resource[].searchParam[].documentation
A portion of either family or given name using some kind of phonetic matching algorithm

# rest[].resource[].searchParam[].documentation
The Practitioner's association with a provider identifier (Danish: Ydernummer)

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's data using a fulltext search

# rest[].resource[].searchParam[].documentation
Return resources linked to by the given target

# rest[].resource[].searchParam[].documentation
Only return resources which were last updated as specified by the given range

# rest[].resource[].searchParam[].documentation
Search for resources which have the given profile

# rest[].resource[].searchParam[].documentation
Search for resources which have the given security labels

# rest[].resource[].searchParam[].documentation
Search for resources which have the given tag

# rest[].resource[].searchParam[].documentation
Search the contents of the resource's narrative using a fulltext search

# rest[].resource[].searchParam[].documentation
Whether this practitioner's record is in active use

# rest[].resource[].searchParam[].documentation
The period during which the practitioner is authorized to perform in these role(s)

# rest[].resource[].searchParam[].documentation
Technical endpoints providing access to services operated for the practitioner with this role

# rest[].resource[].searchParam[].documentation
One of the locations at which this practitioner provides care

# rest[].resource[].searchParam[].documentation
The identity of the organization the practitioner represents / acts on behalf of

# rest[].resource[].searchParam[].documentation
Practitioner that is able to provide the defined services for the organation

# rest[].resource[].searchParam[].documentation
The practitioner can perform this role at for the organization

# rest[].resource[].searchParam[].documentation
The list of healthcare services that this worker provides for this role's Organization/Location(s)

# rest[].resource[].searchParam[].documentation
The practitioner has this specialty at an organization

# rest[].resource[].searchParam[].documentation
Only return resources which were last updated as specified by the given range

# rest[].resource[].searchParam[].documentation
When the activity was recorded / updated

# rest[].resource[].searchParam[].documentation
Target Reference(s) (usually version specific)

# rest[].operation[].documentation
This operation persists login information into CareTeams and PractitionerRoles
The following elements of each careteam are mandatory:
- id: Reference based on the careteam from the saml security token
- status: any
- name: any
- reasonCode: any
- participant: 1 for each careteam-role in the saml security token
-- role: from the saml security token
-- member: reference to the practitioner
-- onBehalfOf: reference to organization (cannot be set currently because of a bug in hapi)

Persist-login will find each careteam, and update it with any new participants and roles from the input bundle.
The input careteam resources are are used as a container for the participant list. The rest of the fields are not used.
The following elements of each PractitionerRole are mandatory:
- practitioner
- organization
- code: roles from the saml security token (CareteamParticipantRole valueset)

Persist-login will search for practitionerRoles for each combination of (practitioner, organization) and create it if it doesn't already exists.

# rest[].operation[].documentation
Import a bundle containing at least one organization tree.

# rest[].operation[].documentation
Operation for polling the status of a previously initiated FHIR Bulk Data System Level Export. A complete URL including the '_jobId' is returned in the 'Content-Location' response header when initiating the export. A 'GET' request to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk data files. A 'DELETE' request can be used to cancel the export. If the export has already finished, the delete will return '404 Not Found', else the export job will be cancelled and a '202 Accepted' is returned with an operation outcome response.
### Parameters
- _jobId: the job ID for the Bulk Export job which was returned in the 'Content-Location' header when initiating the export

# rest[].operation[].documentation
FHIR Operation to initiate an export of data from a FHIR server. The type of resources returned can be restricted using the '_type' parameter, and the '_since' parameter can be used to restrict resources to be only included if changed since the supplied time. The FHIR server support invocation of this operation using the [FHIR Asynchronous Request Pattern](http://hl7.org/fhir/R4/async.html).
## Initiation of export
The initiation of an export must specify the request header 'Prefer: respond-async', and will return '202 Accepted' with a polling location in the response header 'Content-Location'. The polling location is for the endpoint '$export-poll-status' and has the export job ID as parameter '_jobId'.
### Parameters
- _outputFormat: Optional parameter to specify the output format of the exported files. Default is 'application/fhir+ndjson'
- _type: Optional parameter to specify a comma separated list of resource types to be included in the export. If not provided, all resource types will be included.
- _since: Optional parameter to specify a time. Only resources that have been created or modified after this time will be included in the export (i.e., if Resource.meta.lastUpdated is later than the supplied _since time).
- _until: Optional parameter to specify a time. Only resources that have been created or modified before this time will be included in the export (i.e., if Resource.meta.lastUpdated is earlier than the supplied _until time).
- _typeFilter: Optional parameter to apply search filter of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied when searching resources.
- _typePostFetchFilterUrl: Optional parameter to apply filtering of resources for export. It is a string of comma-delimited FHIR REST search queries in the format [resourceType]?[parameters]. The filter will be applied on resources after being fetched from the database.
- _includeHistory: Optional parameter to specify whether historical versions of resources should be included in the export. Default is false.
- _exportId: Optional parameter to specify a client provided identifier for the export. Resulting exported files (Binary) will be labeled with the identifer in meta extension 'https://hapifhir.org/NamingSystem/bulk-export-identifier'
## Polling status of export
Subsequent GET requests to the polling location will return '202 Accepted' with a response header 'X-Progress' containing a status message for the progress of the export job. When the job has finished, the polling location will return '200 OK', and the contents of the body will be a JSON object providing metadata and links to the generated bulk export data files.
## Retrieving exported files
The JSON object returned when the export job is complete will contain a list of files (Binary resources) available for download. Each file can be retrieved using a standard HTTP GET request to the provided URL. The security context of the Binary resources resulting from the export is the user that initiated the export. The files can therefore only be retrieved by the same user.
### Retention of exported files
The exported files are retained for a limited time after which they are deleted. The retention time is a server configuration with default 2 hours.

# rest[].operation[].documentation
Provides the number of resources currently stored on the server, broken down by resource type