search parameters

post
/organizations/{organizationId}/fhir/3/searchparameter

A search parameter that defines a named search item that can be used to search/filter on a resource.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringSearchParameterThis is a SearchParameter resource
urlstringAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this search parameter. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
publisherstringThe name of the individual or organization that published the search parameter.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the search parameter is intended to be used.
purposestringExplaination of why this search parameter is needed and why it has been designed as it has.
codestringThe code used in the URL or the parameter name in a parameters resource for this search parameter.
basearray()The base resource type(s) that this search parameter can be used against.
typestringnumber|date|string|token|reference|composite|quantity|uriThe type of value a search parameter refers to, and how the content is interpreted.
derivedFromstringWhere this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
descriptionstringA free text natural language description of the search parameter from a consumer's perspective. and how it used.
expressionstringA FHIRPath expression that returns a set of elements for the search parameter.
xpathstringAn XPath expression that returns a set of elements for the search parameter.
xpathUsagestringnormal|phonetic|nearby|distance|otherHow the search parameter relates to the set of elements returned by evaluating the xpath query.
targetarray()Types of resource (if a resource is referenced).
comparatorarray()eq|ne|gt|lt|ge|le|sa|eb|apComparators supported for the search parameter.
modifierarray()missing|exact|contains|not|text|in|not-in|below|above|typeA modifier supported for the search parameter.
chainarray()Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
componentarray(SearchParameter_Component)Used to define the parts of a composite search parameter.

Response

patch
/organizations/{organizationId}/fhir/3/searchparameter/{resourceId}

A search parameter that defines a named search item that can be used to search/filter on a resource.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSearchParameterThis is a SearchParameter resource
urlstringAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this search parameter. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
publisherstringThe name of the individual or organization that published the search parameter.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the search parameter is intended to be used.
purposestringExplaination of why this search parameter is needed and why it has been designed as it has.
codestringThe code used in the URL or the parameter name in a parameters resource for this search parameter.
basearray()The base resource type(s) that this search parameter can be used against.
typestringnumber|date|string|token|reference|composite|quantity|uriThe type of value a search parameter refers to, and how the content is interpreted.
derivedFromstringWhere this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
descriptionstringA free text natural language description of the search parameter from a consumer's perspective. and how it used.
expressionstringA FHIRPath expression that returns a set of elements for the search parameter.
xpathstringAn XPath expression that returns a set of elements for the search parameter.
xpathUsagestringnormal|phonetic|nearby|distance|otherHow the search parameter relates to the set of elements returned by evaluating the xpath query.
targetarray()Types of resource (if a resource is referenced).
comparatorarray()eq|ne|gt|lt|ge|le|sa|eb|apComparators supported for the search parameter.
modifierarray()missing|exact|contains|not|text|in|not-in|below|above|typeA modifier supported for the search parameter.
chainarray()Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
componentarray(SearchParameter_Component)Used to define the parts of a composite search parameter.

Response

get
/organizations/{organizationId}/fhir/3/searchparameter/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/searchparameter/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/searchparameter/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

delete
/organizations/{organizationId}/fhir/3/searchparameter/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/searchparameter

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
basestring
codestring
componentstring
datestring
derived-fromstring
descriptionstring
jurisdictionstring
namestring
publisherstring
statusstring
targetstring
typestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

get
/organizations/{organizationId}/fhir/3/searchparameter/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

post
/organizations/{organizationId}/fhir/3/searchparameter/_search

A search parameter that defines a named search item that can be used to search/filter on a resource.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
basestring
codestring
componentstring
datestring
derived-fromstring
descriptionstring
jurisdictionstring
namestring
publisherstring
statusstring
targetstring
typestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSearchParameterThis is a SearchParameter resource
urlstringAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this search parameter. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
publisherstringThe name of the individual or organization that published the search parameter.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the search parameter is intended to be used.
purposestringExplaination of why this search parameter is needed and why it has been designed as it has.
codestringThe code used in the URL or the parameter name in a parameters resource for this search parameter.
basearray()The base resource type(s) that this search parameter can be used against.
typestringnumber|date|string|token|reference|composite|quantity|uriThe type of value a search parameter refers to, and how the content is interpreted.
derivedFromstringWhere this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
descriptionstringA free text natural language description of the search parameter from a consumer's perspective. and how it used.
expressionstringA FHIRPath expression that returns a set of elements for the search parameter.
xpathstringAn XPath expression that returns a set of elements for the search parameter.
xpathUsagestringnormal|phonetic|nearby|distance|otherHow the search parameter relates to the set of elements returned by evaluating the xpath query.
targetarray()Types of resource (if a resource is referenced).
comparatorarray()eq|ne|gt|lt|ge|le|sa|eb|apComparators supported for the search parameter.
modifierarray()missing|exact|contains|not|text|in|not-in|below|above|typeA modifier supported for the search parameter.
chainarray()Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
componentarray(SearchParameter_Component)Used to define the parts of a composite search parameter.

Response

put
/organizations/{organizationId}/fhir/3/searchparameter/{resourceId}

A search parameter that defines a named search item that can be used to search/filter on a resource.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSearchParameterThis is a SearchParameter resource
urlstringAn absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this search parameter. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
publisherstringThe name of the individual or organization that published the search parameter.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the search parameter is intended to be used.
purposestringExplaination of why this search parameter is needed and why it has been designed as it has.
codestringThe code used in the URL or the parameter name in a parameters resource for this search parameter.
basearray()The base resource type(s) that this search parameter can be used against.
typestringnumber|date|string|token|reference|composite|quantity|uriThe type of value a search parameter refers to, and how the content is interpreted.
derivedFromstringWhere this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
descriptionstringA free text natural language description of the search parameter from a consumer's perspective. and how it used.
expressionstringA FHIRPath expression that returns a set of elements for the search parameter.
xpathstringAn XPath expression that returns a set of elements for the search parameter.
xpathUsagestringnormal|phonetic|nearby|distance|otherHow the search parameter relates to the set of elements returned by evaluating the xpath query.
targetarray()Types of resource (if a resource is referenced).
comparatorarray()eq|ne|gt|lt|ge|le|sa|eb|apComparators supported for the search parameter.
modifierarray()missing|exact|contains|not|text|in|not-in|below|above|typeA modifier supported for the search parameter.
chainarray()Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
componentarray(SearchParameter_Component)Used to define the parts of a composite search parameter.

Response