FAQ v2
How to use prefix in FHIR search ?
See documentation here: Prefix FHIR
How to return resource created/updated instead of the id ?
FHIR offers many return types for creation/update of resources. These different types are:
- Prefer: return=minimal
- Prefer: return=representation
- Prefer: return=OperationOutcome
See documentation here: Return preferences
By default, return type is
OperationOutcome
. To show the entire resource, you must add headerPrefer: return=representation
How many parameters can I add on my search request ?
At Lifen, search queries go through ElasticSearch. This search engine has some limitations (see documentation here)
Can I search on operation $everything
?
$everything
?Lifen doesn't support this operation for now
See documentation here: $everything FHIR operation
Otherwise, instead of using $everything
operation, the _include
parameter can do the same thing but with more accuracy.
For example: GET /Encounter?_include=Encounter:subject
will get all encounters with their own associate subject in results list
See documentation here: _include FHIR search parameter
How to search by FHIR extension ?
Lifen supports FHIR extension. As such, extensibility is a fundamental part of the design of FHIR specification. Every element in a resource can
have extension child elements to represent additional information that is not part of the basic definition of the resource. You can read more
about extension here
Example of an extension :
{
extension: [
{
"url": "http://lifen.fr/fhir/StructureDefinition/Resource/ExtensionX",
"valueBoolean": true
}
]
}
Search by extension in the FHIR search must respect the token param syntax fitting into one of the following schemas:
[baseUrl]/[resource]?_extension=[url]|[value]
: any resource with extension where the value of [url] matches the url property and the value of
[value] matches the value property[baseUrl]/[resource]?_extension=[url]|
: any resource with extension where the value of [url] matches the url property[baseUrl]/[resource]?_extension=[value]
: any resource with extension where the value of [value] matches the value property[baseUrl]/[resource]?_extension=|[value]
: any resource with extension where the value of [value] matches the value property
To know how you can search resources by this extension you can refer to : token param search documentation
Updated about 2 years ago