Search Parameters
Below are the supported Search parameters available for the supported resources :
Resource : Observation
| Search Parameter | Maps to | Type |
|---|---|---|
| based-on | basedOn.reference | reference |
| category | category.coding.system / category.coding.code | token |
| code | code.coding.system / code.coding.code | token |
| data-absent-reason | dataAbsentReason.coding.system / dataAbsentReason.coding.code | token |
| date | effectiveDateTime / effectivePeriod.start and effectivePeriod.end | date |
| device | device.reference | reference |
| identifier | identifier.system / identifier.value | token |
| performer | performer.reference | reference |
| status | status | token |
| subject | subject.reference | reference |
| value-concept | valueCodeableConcept.coding.system / valueCodeableConcept.coding.code |
token |
| value-quantity | valueQuantity.system / valueQuantity.value | quantity |
| value-string | valueString | string |
Resource : Device
| Search Parameter | Maps to | Type |
|---|---|---|
| status | status | token |
| type | type.coding.system/type.coding.code | token |
| manufacturer | manufacturer | string |
| model | model | string |
| version | version | string |
| identifier | identifier.system / identifier.value | token |
Resource : DeviceComponent
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system / identifier.value | token |
| type | type.coding.system/type.coding.code | token |
| source | source.reference | reference |
Resource : DeviceMetric
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system / identifier.value | token |
| type | type.coding.system/type.coding.code | token |
| source | source.reference | reference |
| parent | parent.reference | reference |
| category | category | token |
Resource : Patient
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system / identifier.value | token |
| active | active | token |
Resource : MedicationRequest
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system/identifier.value | token |
| code | medicationCodeableConcept.coding.system/ medicationCodeableConcept.coding.code |
token |
| intent | intent | token |
| status | status | token |
| subject | subject.reference | reference |
| requester | requester.agent.reference | reference |
| authoredon | authoredOn | date |
Resource : MedicationAdministration
| Search Parameter | Maps to | Type |
|---|---|---|
| status | status | token |
| code | medicationCodeableConcept.coding.system/ medicationCodeableConcept.coding.code |
token |
| medication | medicationReference.reference | reference |
| subject | subject.reference | reference |
| performer | performer.actor.reference | reference |
| effective-time | effectiveDateTime / effectivePeriod.start and effectivePeriod.end |
date |
| identifier | identifier.system/identifier.value | token |
| dose | dosage.dose.value/ dosage.dose.system/ dosage.dose.code |
quantity |
Resource : CarePlan
| Search Parameter | Maps to | Type |
|---|---|---|
| part-of | partOf.reference | reference |
| status | status | token |
| intent | intent | token |
| subject | subject.reference | reference |
| identifier | identifier.system/identifier.value | token |
| category | category.coding.system / category.coding.code | token |
| title | title | string |
Resource : MedicationStatement
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system/identifier.value | token |
| status | status | token |
| category | category | token |
| subject | subject.reference | reference |
| effective | effectiveDateTime / effectivePeriod.start and effectivePeriod.end |
date |
| code | medicationCodeableConcept.coding.system/ medicationCodeableConcept.coding.code |
token |
| part-of | partOf.reference | reference |
Resource : Goal
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system/identifier.value | token |
| status | status | token |
| category | category | token |
| subject | subject.reference | reference |
| status-date | statusDate | date |
| description | description.coding.system/ description.coding.code |
token |
| detailQuantity-value | target.detailQuantity.value/ target.detailQuantity.system/ target.detailQuantity.code |
quantity |
| detailQuantity-comparator | target.detailQuantity.system/ target.detailQuantity.comparator |
token |
| detailRange-low | target.detailRange.low.value/ target.detailRange.low.system/ target.detailRange.low.code |
quantity |
| detailRange-high | target.detailRange.high.value/ target.detailRange.high.system/ target.detailRange.high.code |
quantity |
Resource : Condition
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system/identifier.value | token |
| code | code.coding.system/code.coding.code | token |
| coding-display | code.coding.system/code.coding.display | token |
| subject | subject.reference | reference |
| onset-date | onsetDateTime | date |
Resource : Provenance
| Search Parameter | Maps to | Type |
|---|---|---|
| target | target.reference | reference |
| target-identifier | target.identifier.value | string |
| agent | agent.whoReference.reference | reference |
| recorded | recorded | date |
| _id | id | string |
| extension-url | extension.url | string |
| extension-valueString | extension.valueString | string |
| lastUpdated | meta.lastUpdated | string |
Resource : Medication
[Available in DEV/TEST Environment Only)]
| Search Parameter | Maps to | Type |
|---|---|---|
| ingredient | ingredient.itemReference.reference | reference |
| code-text | code.text | string |
Resource : Substance
[Available in DEV/TEST Environment Only)]
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system/identifier.value | token |
| code | code.coding.system/code.coding.code | token |
| coding-display | code.coding.display | string |
| status | status | token |
Resource : RiskAssessment
[Available in DEV/TEST Environment Only)]
| Search Parameter | Maps to | Type |
|---|---|---|
| identifier | identifier.system/identifier.value | token |
| subject | subject.reference | reference |
| condition | condition.reference | reference |
| date | occurrenceDateTime | date |
Notes on effectiveDatetime search criteria :
Fhir searches queries for date datatype must be aligned with the specification described in FHIR API Search STU3 documentation.
http://hl7.org/fhir/STU3/search.html#prefix http://hl7.org/fhir/STU3/search.html#date As per FHIR definition (see hl7.org/fhir/STU3/search.html#prefix)
example :
Patient:
gigyaId: fhirstack-3639;
fhiriD: LQqvaiq-13a-5
Observation 1: "effectiveDateTime": "2022-01-20T10:00:00+00:00",
Observation 2: "effectiveDateTime": "2022-01-21T10:00:00+00:00",
Observation 3: "effectivePeriod": { "start": "2022-01-19T10:00:00+00:00", "end": "2022-01-22T10:00:00+00:00" }
Observation 4: "effectivePeriod": { "start": "2022-01-20T14:00:00+00:00", "end": "2022-01-20T21:00:00+00:00" }
Observation 5: "effectivePeriod": { "start": "2022-01-21T14:00:00+00:00", "end": "2022-01-22T05:00:00+00:00" }
Query date range:
testing EQ filter: subject=Patient/LQqvaiq-13a-5&date=eq2022-01-20
expected number of observations: Observation 1, 4
testing GE/LE filter: subject=Patient/LQqvaiq-13a-5&date=ge2022-01-19&date=le2022-01-20
expected number of observations: Observation 1, 3, 4
For Date search we support only following prefixes :
eq (if there is no prefix present, this is the default)
lt (less than)
le (less or equals)
gt (greater than)
ge (greater or equals)
ne (not equals)
Note: For modifiers, the ones that are supported are :exact and :contains
:exact and :contains are used for text parameters, in order to retrieve values with a exact value, or contains an specific string. Example:
value-string:exact=sample
value-string:contains=sample