FHIR CareTeam

Base Path: /fhir/4.0/CareTeam

Version: 2.0.0

The FHIR CareTeam API allows you to look up details about those planned to be involved in the care of the patient.

The endpoint provides the ability to:

  • Retrieve all CareTeam resources that match a search criteria for a given patient.
  • Retrieve a specific CareTeam resource based on its resource ID.
  • Retrieve the history of a CareTeam resource based on its resource ID.
  • Retrieve a specific version of a CareTeam resource based on its FHIR ID and Version ID.
  • Retrieve summaries of all CareTeam resources that match a search criteria for a given patient
  • Retrieve CareTeam results from third-party sources.
  • Supports exporting resources via FHIR Bulk.

The data returned in this API is subject to privacy and permissions settings, refer to the Working with Privacy guide to learn how this might affect your application.

The CareTeam API aggregates data from multiple sources, to learn about working with aggregated APIs refer to the Working with Aggregation guide in the Knowledge Hub.

This API is based on the R4 release of the FHIR standard, for more information on this API refer to the official FHIR documentation.

Methods

Retrieve CareTeams for a Patient

GET /fhir/4.0/CareTeam/

This method returns all care teams for the patient identified either by patient.identifier, or by patient. Optionally filtering by using multiple search parameters.

Known Issues: CareTeams that have multiple Patient participants (CareTeam.participant.member which can be a Patient reference), cannot be retrieved due to privacy.

Parameters

Name

Type

Data Type

Description

Name:

patient.identifier

required

Type:

query

Data Type:

string

Description:

The patient identifier consists of patient identifier namespace (also known as the system) and identifier, separated using a URL encoded | character (i.e., %7c).

Note:

  • You must either define the patient.identifier or patient, not both.

  • In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

    Sample format of the query is

    • patient.identifier={namespace}|{identifier}
    • patient.identifier={namespace}|{identifier} & patient.gender=male & patient.birthdate=2002-05-01


Sample Value: ORION|186a188e

Name:

patient

required

Type:

query

Data Type:

string

Description:

The patient resource id.

Note:

  • You must either define the patient.identifier or patient, not both.
  • In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample format of the query is

  • patient={patient FHIRID}
  • patient={patient FHIRID} & patient.gender=male & patient.birthdate=2002-05-01


Sample Value: GE4DMYJRHA4GKQCPJBBVA

Name:

category

optional

Type:

query

Data Type:

array

Description:

Filters the CareTeams to ones with a team type that matches the specified category. The category value consists of a coding system and a code separated using a URL encoded | character i.e. %7c.

Note: Supports passing in a comma-separated list of values.


Sample Value: urn:text:http://hl7.org/fhir/ValueSet/care-team-category%7CLA28867-2

Name:

date

optional

Type:

query

Data Type:

array

Description:

Filters the care teams to those with a defined period of time the care team covers, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: gt2013-01-01T01:00:00%2B13:00

Name:

encounter

optional

Type:

query

Data Type:

array

Description:

Filters CareTeams by the referenced encounter, identified by their CareTeam.encounter reference.

Note: encounter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: urn:text:Encounter/1A2B3C4D5E6F7G8H9I

Name:

identifier

optional

Type:

query

Data Type:

array

Description:

Filters CareTeams by the specified external ID associated with this CareTeam.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.


Sample Value: System%7C9d3930f4-7a8c-4104-ba1f-1ea28c5f3e96

Name:

participant

optional

Type:

query

Data Type:

array

Description:

Filters CareTeams to those that include a specified participant (member) as part of the team, identified by their CareTeam.participant.member reference.

Note: performer can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Provider/1A2B3C4D5E6F7G8H9I

Name:

status

optional

Type:

query

Data Type:

array

Description:

Filters the CareTeams to those that match the specified status. The status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

  • proposed
  • active
  • suspended
  • inactive
  • entered-in-error

Note:

  • If a status system is specified only http://hl7.org/fhir/care-team-status can be used.
  • Supports passing in a comma-separated list of values.


Sample Value: active

Name:

name

optional

Type:

query

Data Type:

array

Description:

Filters the CareTeams to those that include a specified string within the CareTeam.name.

Note: Supports passing in a comma-separated list of values.


Sample Value: treatment

Name:

-include-sources

optional

Type:

query

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameters can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CareTeam

Name:

-exclude-sources

optional

Type:

query

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CareTeam

Name:

_lastUpdated

optional

Type:

query

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

  • _lastUpdated=gt{dateTimeValue}
  • _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}


Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_summary

optional

Type:

query

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

  • true: return summaries only
  • false: return full resources
  • count: return the count of search matches
  • text: return only the text, id, meta, and top-level mandatory elements
  • data: remove the text element


Sample Value: true

Name:

_elements

optional

Type:

query

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=code,category,severity,_elements:exclude=*.extension,*.encounter

Name:

_cursor

optional

Type:

query

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page


Name:

_count

optional

Type:

query

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.


Sample Value: 30

Name:

_sort

optional

Type:

query

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • date to sort by CareTeam.period ascending
  • -date to sort by CareTeam.period descending
  • name to sort by CareTeam.name ascending
  • -name to sort by CareTeam.name descending
  • _lastUpdated to sort by CareTeam.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by CareTeam.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -date

Sample Value: _sort=-date,_sort=-date,-_lastUpdated,-name

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response.

Possible values are application/json and application/xml. The default value is application/xml.


Sample Value: application/json

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* CareTeam resources.

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Retrieve specific CareTeams for a Patient identified by patient identifier and status
curl -X GET "https://developer-solution/fhir/4.0/CareTeam?patient.identifier=ORION%7C186a188e&status=active" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve CareTeams for a Patient

POST /fhir/4.0/CareTeam/_search

This method returns all care teams for the patient identified either by patient.identifier, or by patient. Optionally filtering by the care team's category, date that the time period of the team covers, the identifier of the specific encounter associated with the care team, the external ID of the care team, an identifier of the participant who is involved in the care team, and/or the status of the care team. This is the secure alternative to the GET search.

Known Issues: CareTeams that have multiple Patient participants (CareTeam.participant.member which can be a Patient reference), cannot be retrieved due to privacy.

Parameters

Name

Type

Data Type

Description

Name:

Content-Type

required

Type:

header

Data Type:

string

Description:

Specifies how to encode the form data. The Content-Type value must be application/x-www-form-urlencoded.


Sample Value: application/x-www-form-urlencoded

Name:

patient.identifier

required

Type:

formData

Data Type:

string

Description:

The patient identifier consists of patient identifier namespace (also known as the system) and identifier, separated using a URL encoded | character (i.e., %7c).

Note:

  • You must either define the patient.identifier or patient, not both.
  • In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample format of the query is

  • patient.identifier={namespace}|{identifier}
  • patient.identifier={namespace}|{identifier} & patient.gender=male & patient.birthdate=2002-05-01


Sample Value: ORION|186a188e

Name:

patient

required

Type:

formData

Data Type:

string

Description:

The patient resource id.

Note:

  • You must either define the patient.identifier or patient, not both.
  • In addition to having the required patient.identifier or patient, you can defined chained patient elements to define filters on the reference, each of the chained parameters can specify multiple comma separated values.

Sample format of the query is

  • patient={patient FHIRID}
  • patient={patient FHIRID} & patient.gender=male & patient.birthdate=2002-05-01


Sample Value: IFAUCQJNGAYTENBNHBAE6USJJ5HA

Name:

date

optional

Type:

formData

Data Type:

array

Description:

Filters the care teams to those with a defined period of time the care team covers, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

  • date=gt{dateTimeValue}
  • date=ge{dateTimeValue}&date=le{dateTimeValue}


Sample Value: gt2013-01-01T01:00:00%2B13:00

Name:

encounter

optional

Type:

formData

Data Type:

array

Description:

Filters CareTeams by the referenced encounter, identified by their CareTeam.encounter reference.

Note: encounter can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: urn:text:Encounter/1A2B3C4D5E6F7G8H9I

Name:

identifier

optional

Type:

formData

Data Type:

array

Description:

Filters CareTeams by the specified external ID associated with this CareTeam.

Note: The identifier can be a single item or a comma separated list of identifiers. Each identifier is defined by system and value , separated using a URL encoded | character i.e. %7c.


Sample Value: System%7C9d3930f4-7a8c-4104-ba1f-1ea28c5f3e96

Name:

participant

optional

Type:

formData

Data Type:

array

Description:

Filters CareTeams to those that include a specified participant (member) as part of the team, identified by their CareTeam.participant.member reference.

Note: performer can be chained to define filters on the reference, each of the chained parameters can specify multiple comma separated values.


Sample Value: Provider/1A2B3C4D5E6F7G8H9I

Name:

status

optional

Type:

formData

Data Type:

array

Description:

Filters the CareTeams to those that match the specified status. The status may consists of a coding system and a code separated using a URL encoded | character i.e. %7c

The supported values are:

  • proposed
  • active
  • suspended
  • inactive
  • entered-in-error

Note:

  • If a status system is specified only http://hl7.org/fhir/care-team-status can be used.
  • Supports passing in a comma-separated list of values.


Sample Value: active

Name:

name

optional

Type:

formData

Data Type:

array

Description:

Filters the CareTeams to those that include a specified string within the CareTeam.name.

Note: Supports passing in a comma-separated list of values.


Sample Value: treatment

Name:

-include-sources

optional

Type:

formData

Data Type:

array

Description:

The -include-sources parameter defines which sources should be queried for the results.

Note: Either -include-sources or -exclude-sources parameters can be specified, not both. If -include-sources is specified, ONLY the specified sources will be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CareTeam

Name:

-exclude-sources

optional

Type:

formData

Data Type:

array

Description:

The -exclude-sources parameter defines which sources should NOT be queried for the results.

Note: Either -include-sources or -exclude-sources parameter can be specified, not both. If -exclude-sources is specified, the specified sources will NOT be searched. Note that the sources specified should be enabled.


Sample Value: Orion%20Health%E2%84%A2%20R4%20HL7V2%20CareTeam

Name:

_lastUpdated

optional

Type:

formData

Data Type:

array

Description:

Filters based on when the resource version was last changed, before, or after a specific date, date-time, or date range. The supported prefixes are gt, ge, lt, le and eq. If no prefix is used, exact date or date-time matching is implied. Dates must be formatted according to ISO 8601 either as a date only (e.g. 1997-07-16) or as a date-time including the timezone (e.g. 1997-07-16T19:20:30+13:00). Ensure that special characters such as + are URL encoded i.e. %2B.

The format of the query is

  • _lastUpdated=gt{dateTimeValue}
  • _lastUpdated=ge{dateTimeValue}&_lastUpdated=le{dateTimeValue}


Sample Value: ge2012-01-01T01:00:00+13:00

Name:

_summary

optional

Type:

formData

Data Type:

string

Description:

Instructs the server to return a subset of the resource, reducing the size of the reponse payload. Possible values are

  • true: return summaries only
  • false: return full resources
  • count: return the count of search matches
  • text: return only the text, id, meta, and top-level mandatory elements
  • data: remove the text element


Sample Value: true

Name:

_elements

optional

Type:

formData

Data Type:

array

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=date,encounter,status,_elements:exclude=*.encounter

Name:

_cursor

optional

Type:

formData

Data Type:

string

Description:

A server internal parameter to navigate different pages.

This parameter is returned by the server as part of the Bundle 'next' link of a paginated query. And is used to retrieve the next page


Name:

_count

optional

Type:

formData

Data Type:

integer

Description:

Limit the number of match results to the specified _count. When _count is specified, the query will be paginated, and only _count or less results will be returned.

The returned bundle may contain a next link if more results could be available.


Sample Value: 30

Name:

_sort

optional

Type:

formData

Data Type:

array

Description:

Request which order results should be returned in.

Supported _sort parameters are:

  • date to sort by CareTeam.period ascending
  • -date to sort by CareTeam.period descending
  • name to sort by CareTeam.name ascending
  • -name to sort by CareTeam.name descending
  • _lastUpdated to sort by CareTeam.Meta.lastUpdated ascending
  • -_lastUpdatedto sort by CareTeam.Meta.lastUpdated descending

You can use any combination of the parameters


Default Value: -date

Sample Value: _sort=-date,_sort=-date,-_lastUpdated,-name

Name:

_pretty

optional

Type:

formData

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response.

Possible values are application/json and application/xml. The default value is application/xml.


Sample Value: application/json

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a FHIR Bundle containing 0..* OperationOutcome resources and 0..* CareTeam resources.

application/json+fhir

400

This response code is returned when the query is invalid e.g. an invalid parameter or a partial token in the search.

Sample Requests

Retrieve specific care teams for a Patient identified by patient resource id and status
curl -X POST "https://developer-solution/fhir/4.0/CareTeam/_search" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8=' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'patient.identifier=ORION%7C186a188e' \
-d 'status=active'

Retrieve a single CareTeam

GET /fhir/4.0/CareTeam/{id}

This method returns the CareTeam resource matching the requested resource ID.

Known Issues: CareTeams that have multiple Patient participants (CareTeam.participant.member which can be a Patient reference), cannot be retrieved due to privacy.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The ID of the CareTeam resource.


Sample Value: MZSTMYLEMNSGMLJUMYZDKLJUGRQTMLJZHBRTQLJUHAYDQYZYMMYDIYZZGRAFGMI

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=date,encounter,status,_elements:exclude=*.status

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.


Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.


Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a CareTeam resource matching the requested resource ID.

application/json+fhir

400

This code is returned when the FHIR ID is empty or not valid.

application/json+fhir

404

No CareTeam resource found with the requested resource ID.

Sample Requests

Retrieve specific CareTeam identified by a resource id
curl -X GET "https://developer-solution/fhir/4.0/CareTeam/MZSTMYLEMNSGMLJUMYZDKLJUGRQTMLJZHBRTQLJUHAYDQYZYMMYDIYZZGRAFGMI" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve a CareTeam's history

GET /fhir/4.0/CareTeam/{id}/_history

This method returns the change history for a CareTeam resource matching the requested resource ID. CareTeam resources can be retrieved from multiple data sources, and not all sources are able to return history information. This operation will return an empty set of data if no versions of the specified CareTeam can be found, which includes cases where:

  • The specified CareTeam resource cannot be found.
  • The data source for the CareTeam is unable to return history information.

Known Issues: CareTeams that have multiple Patient participants (CareTeam.participant.member which can be a Patient reference), cannot be retrieved due to privacy.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the CareTeam resource


Sample Value: GY4GCNRTHFSGKLLFMNSTALJUGFRGELJYGUZTQLJUME3TOMBTHBSWEMDCMRAFGMI

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=date,encounter,status,_elements:exclude=*.status

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.


Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.


Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

A FHIR Bundle containing 1..* CareTeam resources matching the requested resource ID.

application/json+fhir

400

  • The source providing the CareTeam resource is not capable of returning history of CareTeam resources.

application/json+fhir

404

  • No CareTeam resource found with the requested resource ID.

Sample Requests

Retrieve the history of CareTeam identified by a resource id
curl -X GET "https://developer-solution/fhir/4.0/CareTeam/GY4GCNRTHFSGKLLFMNSTALJUGFRGELJYGUZTQLJUME3TOMBTHBSWEMDCMRAFGMI/_history" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='

Retrieve a specific version of a CareTeam

GET /fhir/4.0/CareTeam/{id}/_history/{versionid}

This method returns a specific version of the CareTeam resource matching the requested resource ID. CareTeam resources can be retrieved from multiple data sources. This operation will return an empty set of data if no versions of the specified CareTeam can be found, which includes cases where:

  • The specified CareTeam resource cannot be found.

Known Issues: CareTeams that have multiple Patient participants (CareTeam.participant.member which can be a Patient reference), cannot be retrieved due to privacy.

Parameters

Name

Type

Data Type

Description

Name:

id

required

Type:

path

Data Type:

string

Description:

The id of the CareTeam resource


Sample Value: GY4GCNRTHFSGKLLFMNSTALJUGFRGELJYGUZTQLJUME3TOMBTHBSWEMDCMRAFGMI

Name:

versionid

required

Type:

path

Data Type:

integer

Description:

The version of the CareTeam resource


Sample Value: 1

Name:

_elements

optional

Type:

query

Data Type:

string

Description:

Request a specific set of elements be returned, or excluded as part of a resource in the search results. Use _elements for the elements to include and _elements:exclude for the elements to exclude.


Sample Value: _elements=date,encounter,status,_elements:exclude=*.status

Name:

_pretty

optional

Type:

query

Data Type:

string

Description:

Ask for a pretty printed response for human convenience.


Default Value: true

Sample Value: true

Name:

_format

optional

Type:

query

Data Type:

string

Description:

Media type of the response. It takes precedence over the accept header. Possible values are json and xml.


Default Value: xml

Sample Value: json

Name:

Accept

optional

Type:

header

Data Type:

string

Description:

Media type of the response. Possible values are application/json and application/xml.


Default Value: application/xml

Sample Value: application/json

Name:

X-Request-Id

optional

Type:

header

Data Type:

string

Description:

Supply a request Id to track the request.


Sample Value: X-Request-ID: adUEctf6urd

Name:

Accept-Language

optional

Type:

header

Data Type:

string

Description:

Specifies the language that the results will be translated to. If not specified it will default to the server's locale. (e.g. fr-FR for french)


Sample Value: en-US

Name:

CSRF-Token

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. The csrfToken from the OHP session must be included in this header.

System will validate the token and reject the request if the token is invalid or not present.

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Name:

X-Send-Open-API

required

Type:

header

Data Type:

string

Description:

This header is required for CSRF protection. This header is required to distinguish the api requests from known senders.

System will validate "X-Send-Open-API" request header is present or not. If it is not present, system will reject the request

Note: Either CSRF-Token or X-Send-Open-API must be included in headers to do the CSRF protection.


Responses

application/json+fhir

200

Returns a CareTeam resource matching the the requested resource ID and version id.

application/json+fhir

400

  • The source providing the CareTeam resource is not capable of returning history of CareTeam resources.

application/json+fhir

404

  • No CareTeam resource found with the requested resource ID.
  • The version id specified does not exist for the CareTeam resource with the requested resource ID.

Sample Requests

Retrieve the version of CareTeam identified by a resource id and a version id
curl -X GET "https://developer-solution/fhir/4.0/CareTeam/GY4GCNRTHFSGKLLFMNSTALJUGFRGELJYGUZTQLJUME3TOMBTHBSWEMDCMRAFGMI/_history/1" \
-H 'Accept: application/json' \
-H 'Authorization: Basic bGV2ZWwxLnN5c19hOk9yaW9uc3k1IT8='