OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build

OpenMRS Core FHIR Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/abertnamanya/openmrs-contrib-fhir2-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Search by RelatedPerson Active Status

Indicates if the related person record is active

Search by RelatedPerson Address

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

Search by RelatedPerson Address City

Searches for RelatedPerson based on city of address

Search by RelatedPerson Address Country

Searches for RelatedPerson based on country of address

Search by RelatedPerson Address Postal Code

Searches for RelatedPerson based on postal code of address

Search by RelatedPerson Address State

Searches for RelatedPerson based on state of address

Search by RelatedPerson Birthdate

Searches for RelatedPerson based on birthdate

Search by RelatedPerson Family Name

A portion of the family name of the related person

Search by RelatedPerson Gender

Searches for RelatedPerson based on gender

Search by RelatedPerson Given Name

A portion of the given name of the related person

Search by RelatedPerson Identifier

An Identifier of the RelatedPerson

Search by RelatedPerson Name

Searches for RelatedPerson based on name

Search by RelatedPerson Patient Reference

The patient this related person is related to

Search condition endpoint by patient identifier id

Searches for Condition by the patient identifier eg) /ws/fhir2/{release}/Condition?patient.identifier={identifier}

Search in AllergyIntolerance endpoint basing on AllergyIntolerance lastUpdated attribute

Searches based on the AllergyIntolerance lastUpdated field for the AllergyIntolerance record eg) /ws/fhir2/{release}/AllergyIntolerance?_lastUpdated={date}

Search in AllergyIntolerance endpoint basing on AllergyIntolerance uuid attribute

Searches based on the AllergyIntolerance uuid field for the AllergyIntolerance record eg) /ws/fhir2/{release}}/AllergyIntolerance?_id={uuid}

Search in Encounter endpoint basing on Encounter location address-country attribute

Searches based on the address-country field for the Encounter record eg) /ws/fhir2/{release}/Encounter?address-country={country}

Search in Encounter endpoint basing on Encounter lastUpdated attribute

Searches based on the Encounter lastUpdated field for the Encounter record eg) /ws/fhir2/{release}/Encounter?_lastUpdated={date}

Search in Encounter endpoint basing on Encounter location address-city attribute

Searches based on the address-city field for the Encounter record eg) /ws/fhir2/{release}/Encounter?address-city={city}

Search in Encounter endpoint basing on Encounter location address-postalcode attribute

Searches based on the address-postalcode field for the Encounter record eg) /ws/fhir2/{release}/Encounter?address-postalcode={postalCode}

Search in Encounter endpoint basing on Encounter location address-state attribute

Searches based on the address-state field for the Encounter record eg) /ws/fhir2/{release}/Encounter?address-state={state}

Search in Encounter endpoint basing on Encounter uuid attribute

Searches based on the Encounter uuid field for the Encounter record eg) /ws/fhir2/{release}}/Encounter?_id={uuid}

Search in Location endpoint basing on location address-city attribute

Searches based on the address-city field for the location record eg) /ws/fhir2/{release}/Location?address-city={city}

Search in Location endpoint basing on location address-country attribute

Searches based on the address-country field for the location record eg) /ws/fhir2/{release}/Location?address-country={country}

Search in Location endpoint basing on location address-postalcode attribute

Searches based on the address-postalcode field for the location record eg) /ws/fhir2/{release}/Location?address-postalcode={postalCode}

Search in Location endpoint basing on location address-state attribute

Searches based on the address-state field for the location record eg) /ws/fhir2/{release}/Location?address-state={state}

Search in Location endpoint basing on location lastUpdated attribute

Searches based on the location lastUpdated field for the location record eg) /ws/fhir2/{release}/Location?_lastUpdated={date}

Search in Location endpoint basing on location name attribute

Searches based on the name field for the location record eg) /ws/fhir2/{release}/Location?name={name}

Search in Location endpoint basing on location partof attribute

Searches based on the partof field for the location record eg) /ws/fhir2/{release}/Location?partof={reference}

Search in Location endpoint basing on location partof reference location name attribute

Searches based on the partof location reference name field for the location record eg) /ws/fhir2/{release}/Location?partof.name={name}

Search in Location endpoint basing on location tag attribute

Searches based on the tag field for the location record eg) /ws/fhir2/{release}/Location?_tag={tag}

Search in Location endpoint basing on location uuid attribute

Searches based on the location uuid field for the location record eg) /ws/fhir2/{release}/Location?_id={uuid}

Search in MedicationRequest endpoint basing on MedicationRequest lastUpdated attribute

Searches based on the MedicationRequest lastUpdated field for the MedicationRequest record eg) /ws/fhir2/{release}/MedicationRequest?_lastUpdated={date-range}

Search in MedicationRequest endpoint basing on MedicationRequest uuid attribute

Searches based on the MedicationRequest uuid field for the MedicationRequest record eg) /ws/fhir2/{release}}/MedicationRequest?_id={uuid}

Search in Practitioner endpoint basing on Practitioner lastUpdated attribute

Searches based on the Practitioner lastUpdated field for the Practitioner record eg) /ws/fhir2/{release}/Practitioner?_lastUpdated={date-range}

Search in Practitioner endpoint basing on Practitioner uuid attribute

Searches based on the Practitioner uuid field for the Practitioner record eg) /ws/fhir2/{release}}/Practitioner?_id={uuid}

Search in Practitioner endpoint basing on Practitioner's address-city attribute

Searches based on the address-city field for the Practitioner record eg) /ws/fhir2/{release}/Practitioner?address-city={city}

Search in Practitioner endpoint basing on Practitioner's address-country attribute

Searches based on the address-country field for the Practitioner record eg) /ws/fhir2/{release}/Practitioner?address-country={country}

Search in Practitioner endpoint basing on Practitioner's address-postalcode attribute

Searches based on the address-postalcode field for the Practitioner record eg) /ws/fhir2/{release}/Practitioner?address-postalcode={postalCode}

Search in Practitioner endpoint basing on Practitioner's address-state attribute

Searches based on the address-state field for the Practitioner record eg) /ws/fhir2/{release}/Practitioner?address-state={state}

Search in Task endpoint basing on Task lastUpdated attribute

Searches based on the Task lastUpdated field for the Task record eg) /ws/fhir2/{release}/Task?_lastUpdated={date}

Search in Task endpoint basing on Task uuid attribute

Searches based on the Task uuid field for the Task record eg) /ws/fhir2/{release}}/Task?_id={uuid}

Search in group endpoint using Managing entity Reference

Search for a group basing on managing entity Reference(Practitioner)

Search serviceRequest endpoint by patient identifier id

Searches for ServiceRequest by the patient identifier eg) /ws/fhir2/{release}/ServiceRequest?patient.identifier={identifier}

Search through AllergyIntolerance endpoint by a given patient

Searches for AllergyIntolerance by a given patient eg) /ws/fhir2/{release}/AllergyIntolerance?patient={patientUuid}

Search through AllergyIntolerance endpoint by a given patient

Searches for AllergyIntolerance by a given patient eg) /ws/fhir2/{release}/AllergyIntolerance?patient.identifier={identifier}

Search through AllergyIntolerance endpoint by subject family
Searches for AllergyIntolerance based on the patient's family name eg) /ws/fhir2/{release}/AllergyIntolerance?subject:Patient.family={familyName}
Search through AllergyIntolerance endpoint by subject given

Searches for AllergyIntolerance based on the patient's given name(s) eg) /ws/fhir2/{release}/AllergyIntolerance?subject:Patient.given={givenName}

Search through AllergyIntolerance endpoint by subject identifier

Searches for AllergyIntolerance by the patient identifier eg) /ws/fhir2/{release}/AllergyIntolerance?subject:Patient.identifier={identifier}

Search through AllergyIntolerance endpoint by subject name

Searches for AllergyIntolerance based on the patient's full or partial name eg) /ws/fhir2/{release}/AllergyIntolerance?subject:Patient.name={name}

Search through AllergyIntolerance endpoint by subject uuid

Searches for AllergyIntolerance by a given subject eg) /ws/fhir2/{release}/AllergyIntolerance?subject:Patient={patientUuid}

Search through AllergyIntolerance endpoint by the category

Searches for AllergyIntolerance based on the category eg) /ws/fhir2/{release}/AllergyIntolerance?category={category}

Search through AllergyIntolerance endpoint by the clinical-status

Searches for AllergyIntolerance based on the clinical-status eg) /ws/fhir2/{release}/AllergyIntolerance?clinical-status={codeable concept}

Search through AllergyIntolerance endpoint by the manifestation

Searches for AllergyIntolerance based on the manifestation eg) /ws/fhir2/{release}/AllergyIntolerance?manifestation={codeable concept}

Search through AllergyIntolerance endpoint by the patient's family name

Searches for AllergyIntolerance based on the patient's family name eg) /ws/fhir2/{release}/AllergyIntolerance?patient.family={familyName}

Search through AllergyIntolerance endpoint by the patient's full or partial name

Searches for AllergyIntolerance based on the patient's full or partial name eg) /ws/fhir2/{release}/AllergyIntolerance?patient-name={name}

Search through AllergyIntolerance endpoint by the patient's given name

Searches for AllergyIntolerance based on the patient's given name(s) eg) /ws/fhir2/{release}/AllergyIntolerance?patient.given={givenName}

Search through AllergyIntolerance endpoint by the severity

Searches for AllergyIntolerance based on the severity eg) /ws/fhir2/{release}/AllergyIntolerance?category={codeable concept}

Search through Encounter endpoint based on location reference

Searches for Encounter based on the location reference uuid eg) /ws/fhir2/{release}/Encounter?location={uuid}

Search through Encounter endpoint by a given Practitioner

Searches for Encounters by a given Practitioner Reference uuid eg) /ws/fhir2/{release}/Encounter?participant={PractitionerUuid}

Search through Encounter endpoint by a given Practitioner

Searches for Encounters by a given Practitioner eg) /ws/fhir2/{release}/Encounter?participant.identifier={identifier}

Search through Encounter endpoint by a given patient

Searches for Encounters by a given patient eg) /ws/fhir2/{release}/Encounter?patient={patientUuid}

Search through Encounter endpoint by a given patient

Searches for Encounters by a given patient eg) /ws/fhir2/{release}/Encounter?patient.identifier={identifier}

Search through Encounter endpoint by encounter type

Searches for Encounter based on encounter type field eg) /ws/fhir2/{release}/Encounter?type={encounterType}

Search through Encounter endpoint by subject family
Searches for Encounter based on the patient's family name eg) /ws/fhir2/{release}/Encounter?subject:Patient.family={familyName}
Search through Encounter endpoint by subject given

Searches for Encounter based on the patient's given name(s) eg) /ws/fhir2/{release}/Encounter?subject:Patient.given={givenName}

Search through Encounter endpoint by subject identifier

Searches for Encounter by the patient identifier eg) /ws/fhir2/{release}/Encounter?subject:Patient.identifier={identifier}

Search through Encounter endpoint by subject name

Searches for Encounter based on the patient's full or partial name eg) /ws/fhir2/{release}/Encounter?subject:Patient.name={name}

Search through Encounter endpoint by subject uuid

Searches for Encounter by a given subject eg) /ws/fhir2/{release}/Encounter?subject:Patient={patientUuid}

Search through Encounter endpoint by the Practitioner's family name

Searches for Encounters based on the Practitioner's family name eg) /ws/fhir2/{release}/Encounter?participant.family={familyName}

Search through Encounter endpoint by the Practitioner's full or partial name

Searches for Encounters based on the Practitioner's full or partial name eg) /ws/fhir2/{release}/Encounter?participant.name={name}

Search through Encounter endpoint by the Practitioner's given name

Searches for Encounters based on the Practitioner's given name(s) eg) /ws/fhir2/{release}/Encounter?participant.given={givenName}

Search through Encounter endpoint by the date when the encounter was created

Searches for Encounter based on the encounter creation date eg) /ws/fhir2/{release}/Encounter?date={date}

Search through Encounter endpoint by the patient's family name

Searches for Encounters based on the patient's family name eg) /ws/fhir2/{release}/Encounter?patient.family={familyName}

Search through Encounter endpoint by the patient's full or partial name

Searches for Encounters based on the patient's full or partial name eg) /ws/fhir2/{release}/Encounter?patient-name={name}

Search through Encounter endpoint by the patient's given name

Searches for Encounters based on the patient's given name(s) eg) /ws/fhir2/{release}/Encounter?patient.given={givenName}

Search through FhirTask endpoint by FhirTask status in the current state

Searches for FhirTask based on the FhirTask status eg) /ws/fhir2/{release}/Task?status={codeable concept}

Search through FhirTask endpoint by the Organization Reference uuid

Searches for FhirTask based on the Organization Reference eg) /ws/fhir2/{release}/Task?owner={uuid}

Search through FhirTask endpoint by the ServiceRequest Reference uuid

Searches for FhirTask based on the ServiceRequest Reference eg) /ws/fhir2/{release}/Task?based-on={ServiceRequestUuid}

Search through MedicationRequest endpoint based on medication reference

Searches for MedicationRequest by medication reference eg) /ws/fhir2/{release}/MedicationRequest?medication={reference}

Search through MedicationRequest endpoint by a given Practitioner

Searches for MedicationRequest by a given Practitioner Reference uuid eg) /ws/fhir2/{release}/MedicationRequest?requestor={Uuid}

Search through MedicationRequest endpoint by a given Practitioner

Searches for MedicationRequest by a given Practitioner eg) /ws/fhir2/{release}/MedicationRequest?requestor.identifier={identifier}

Search through MedicationRequest endpoint by a given patient

Searches for MedicationRequest by a given patient eg) /ws/fhir2/{release}/MedicationRequest?patient={patientUuid}

Search through MedicationRequest endpoint by a given patient

Searches for MedicationRequest by a given patient eg) /ws/fhir2/{release}/MedicationRequest?patient.identifier={identifier}

Search through MedicationRequest endpoint by subject family
Searches for MedicationRequest based on the patient's family name eg) /ws/fhir2/{release}/MedicationRequest?subject:Patient.family={familyName}
Search through MedicationRequest endpoint by subject given

Searches for MedicationRequest based on the patient's given name(s) eg) /ws/fhir2/{release}/MedicationRequest?subject:Patient.given={givenName}

Search through MedicationRequest endpoint by subject identifier

Searches for MedicationRequest by the patient identifier eg) /ws/fhir2/{release}/MedicationRequest?subject:Patient.identifier={identifier}

Search through MedicationRequest endpoint by subject name

Searches for MedicationRequest based on the patient's full or partial name eg) /ws/fhir2/{release}/MedicationRequest?subject:Patient.name={name}

Search through MedicationRequest endpoint by subject uuid

Searches for MedicationRequest by a given subject eg) /ws/fhir2/{release}/MedicationRequest?subject:Patient={patientUuid}

Search through MedicationRequest endpoint by the Practitioner's family name

Searches for MedicationRequest based on the Practitioner's family name eg) /ws/fhir2/{release}/MedicationRequest?requestor.family={familyName}

Search through MedicationRequest endpoint by the Practitioner's full or partial name

Searches for MedicationRequest based on the Practitioner's full or partial name eg) /ws/fhir2/{release}/MedicationRequest?requestor.name={name}

Search through MedicationRequest endpoint by the Practitioner's given name

Searches for MedicationRequest based on the Practitioner's given name(s) eg) /ws/fhir2/{release}/MedicationRequest?requestor.given={givenName}

Search through MedicationRequest endpoint by the patient's family name

Searches for MedicationRequest based on the patient's family name eg) /ws/fhir2/{release}/MedicationRequest?patient.family={familyName}

Search through MedicationRequest endpoint by the patient's full or partial name

Searches for MedicationRequest based on the patient's full or partial name eg) /ws/fhir2/{release}/MedicationRequest?patient-name={name}

Search through MedicationRequest endpoint by the patient's given name

Searches for MedicationRequest based on the patient's given name(s) eg) /ws/fhir2/{release}/MedicationRequest?patient.given={givenName}

Search through Practitioner endpoint by a given Practitioner

Searches for Practitioner by a given Practitioner eg) /ws/fhir2/{release}/Practitioner?identifier={identifier}

Search through Practitioner endpoint by the Practitioner's family name

Searches for Practitioner based on the Practitioner's family name eg) /ws/fhir2/{release}/Practitioner?family={familyName}

Search through Practitioner endpoint by the Practitioner's full or partial name

Searches for Practitioner based on the Practitioner's full or partial name eg) /ws/fhir2/{release}/Practitioner?name={name}

Search through Practitioner endpoint by the Practitioner's given name

Searches for Practitioner based on the Practitioner's given name(s) eg) /ws/fhir2/{release}/Practitioner?given={givenName}

Search through an observation group in the Obervation EndPoint that contains a given observation

Searches for an observation group that contains a given observation eg) /ws/fhir2/{release}/Observation?has-member

Search through condition endpoint by Condition clinical onset age

Searches for condition based on the condition onset age eg) /ws/fhir2/{release}/Condition?onset-age={date}

Search through condition endpoint by Condition clinical onset date

Searches for condition based on the condition onset date concept eg) /ws/fhir2/{release}/Condition?onset-date={date}

Search through condition endpoint by Condition clinical status

Searches for condition based on the condition clinical status concept eg) /ws/fhir2/{release}/Condition?clinical-status={codeable concept}

Search through condition endpoint by Occurrence when service should occurance

Searches for condition based on to occurrent date eg) /ws/fhir2/{release}/Condition?occurrence={date}

Search through condition endpoint by Practitioner family

Searches for condition based on the Practitioner's family name eg) /ws/fhir2/{release}/Condition?requester:Practitioner.family={familyName}

Search through condition endpoint by Practitioner given

Searches for condition based on the Practitioner's given name(s) eg) /ws/fhir2/{release}/Condition?requester:Practitioner.given={givenName}

Search through condition endpoint by Practitioner identifier

Searches for condition by the Practitioner identifier eg) /ws/fhir2/{release}/Condition?requester:Practitioner.identifier={identifier}

Search through condition endpoint by Practitioner name

Searches for condition based on the Practitioner's full or partial name eg) /ws/fhir2/{release}/Condition?requester:Practitioner.name={name}

Search through condition endpoint by Practitioner uuid

Searches for condition by Practitioner uuid who requested the service eg) /ws/fhir2/{release}/Condition?requester:Practitioner={uuid}

Search through condition endpoint by concept code

Searches for condition based on the condition concept code eg) /ws/fhir2/{release}/Condition?code={code}

Search through condition endpoint by date when the record was created

Searches for condition based on the condition creation date eg) /ws/fhir2/{release}/Condition?recorded-date={date}

Search through condition endpoint by encounter uuid

Searches for condition based on the condition encounter Uuid eg) /ws/fhir2/{release}/Condition?encounter={uuid}

Search through condition endpoint by patient uuid

Searches for condition by a given patient Uuid eg) /ws/fhir2/{release}/Condition?patient={uuid}

Search through condition endpoint by service Uuid

Searches for condition based on service Uuid eg) /ws/fhir2/{release}/Condition?_id={uuid}

Search through condition endpoint by service lastUpdated field

Searches for condition based on service lastUpdated field eg) /openmrs/ws/fhir2/{release}/Condition?_lastUpdated={date}

Search through condition endpoint by subject given

Searches for condition based on the patient's given name(s) eg) /ws/fhir2/{release}/Condition?subject:Patient.given={givenName}

Search through condition endpoint by subject identifier

Searches for condition by the patient identifier eg) /ws/fhir2/{release}/Condition?subject:Patient.identifier={identifier}

Search through condition endpoint by subject name

Searches for condition based on the patient's full or partial name eg) /ws/fhir2/{release}/Condition?subject:Patient.name={name}

Search through condition endpoint by subject uuid

Searches for condition by a given subject eg) /ws/fhir2/{release}/condition?subject:Patient={patientUuid}

Search through condition endpoint by the patient's family name

Searches for condition based on the patient's family name eg) /ws/fhir2/{release}/Condition?patient.family={familyName}

Search through condition endpoint by the patient's full or partial name

Searches for condition based on the patient's full or partial name eg) /ws/fhir2/{release}/Condition?patient-name={name}

Search through condtion endpoint by subject family
Searches for condition based on the patient's family name eg) /ws/fhir2/{release}/Condition?subject:Patient.family={familyName}
Search through condtion endpoint by the patient's given name

Searches for condition based on the patient's given name(s) eg) /ws/fhir2/{release}/Condition?patient.given={givenName}

Search through observation endpoint by a given patient

Searches for observations by a given patient eg) /ws/fhir2/{release}/Observation?patient={uuid}

Search through observation endpoint by a given patient

Searches for observations by a given patient eg) /ws/fhir2/{release}/Observation?patient.identifier={identifier}

Search through observation endpoint by category

Searches for observations by the observation category eg) /ws/fhir2/{release}/Observation?category={category}

Search through observation endpoint by concept code

Searches for observations with particular codes (concepts) eg) /ws/fhir2/{release}/Observation?code={code}

Search through observation endpoint by date

Searches for observations by the observation date and time eg) /ws/fhir2/{release}/Observation?date={date}

Search through observation endpoint by encounter

Searches for observations by the observation encounter eg) /ws/fhir2/{release}/Observation?encounter.type={type}

Search through observation endpoint by subject family
Searches for observations based on the patient's family name eg) /ws/fhir2/{release}/Observation?subject:Patient.family={familyName}
Search through observation endpoint by subject given

Searches for observations based on the patient's given name(s) eg) /ws/fhir2/{release}/Observation?subject:Patient.given={givenName}

Search through observation endpoint by subject identifier

Searches for observations by the patient identifier eg) /ws/fhir2/{release}/Observation?subject:Patient.identifier={identifier}

Search through observation endpoint by subject name

Searches for observations based on the patient's full or partial name eg) /ws/fhir2/{release}/Observation?subject:Patient.name={name}

Search through observation endpoint by subject uuid

Searches for observations by a given subject eg) /ws/fhir2/{release}/Observation?subject:Patient={patientUuid}

Search through observation endpoint by the patient's family name

Searches for observations based on the patient's family name eg) /ws/fhir2/{release}/Observation?patient.family={familyName}

Search through observation endpoint by the patient's full or partial name

Searches for observations based on the patient's full or partial name eg) /ws/fhir2/{release}/Observation?patient-name={name}

Search through observation endpoint by the patient's given name

Searches for observations based on the patient's given name(s) eg) /ws/fhir2/{release}/Observation?patient.given={givenName}

Search through patient endpoint basing on dateCreated or dateUpdated field of the patient record

Searches based on the the dateCreated or dateUpdated field for the patient record eg) /ws/fhir2/{release}/Patient?_lastUpdated={date-range}

Search through patient endpoint by the patient's birthdate attribute

Searches based on the patient's birthdate eg) /ws/fhir2/{release}/Patient?birthdate={date}

Search through patient endpoint by the patient's death-date attribute

Searches based on the death date of the patient (if any) eg) /ws/fhir2/{release}/Patient?death-date={date}

Search through patient endpoint by the patient's full or partial name

Searches for patient based on patient's full or partial name eg) /ws/fhir2/{release}/Patient?name={name}

Search through patient endpoint by the patient's gender attribute

Searches based on the gender of the patient. Note that this value must be from the AdministrativeGender valueset eg) /ws/fhir2/{release}/Patient?gender={gender}

Search through patient endpoint by the patient's location city

Searches based on the patient's recorded city/village of address eg) /ws/fhir2/{release}/Patient?address-city={city}

Search through patient endpoint by the patient's location country

Searches based on the patient's recorded country of address eg) /ws/fhir2/{release}/Patient?address-country={country}

Search through patient endpoint by the patient's location postal code

Searches based on the patient's recorded postal code of address eg) /ws/fhir2/{release}/Patient?address-postalcode={postalCode}

Search through patient endpoint by the patient's location state

Searches based on the patient's recorded state/province of addresseg) /ws/fhir2/{release}/Patient?address-state={state}

Search through patient endpoint by the patient's uuid

Searches based on the exact UUID of the patient record eg} /ws/fhir2/{release}/Patient?_id={uuid}

Search through patient endpoint checking for those that passed on or still alive

Searches based on whether a patient is marked as deceased. Acceptable values are true or false eg) /ws/fhir2/{release}/Patient?deceased={boolean}

Search through person endpoint basing on dateCreated or dateUpdated field of the person record

Searches based on the the dateCreated or dateUpdated field for the person record eg) /ws/fhir2/{release}/Person?_lastUpdated={date-range}

Search through person endpoint by the person's birthdate attribute

Searches based on the person's birthdate eg) /ws/fhir2/{release}/Person?birthdate={date}

Search through person endpoint by the person's full or partial name

Searches for Person based on full or partial name eg) /ws/fhir2/{release}/Person?name={name}

Search through person endpoint by the person's gender attribute

Searches based on the gender of the person. Note that this value must be from the AdministrativeGender valueset eg) /ws/fhir2/{release}/Person?gender={gender}

Search through person endpoint by the person's location city

Searches based on the person's recorded city/village of address eg) /ws/fhir2/{release}/Person?address-city={city}

Search through person endpoint by the person's location country

Searches based on the person's recorded country of address eg) /ws/fhir2/{release}/Person?address-country={country}

Search through person endpoint by the person's location postal code

Searches based on the person's recorded postal code of address eg) /ws/fhir2/{release}/Person?address-postalcode={postalCode}

Search through person endpoint by the person's location state

Searches based on the person's recorded state/province of address eg) /ws/fhir2/{release}/Person?address-state={state}

Search through person endpoint by the person's uuid

Searches based on the exact UUID of the person record eg) /ws/fhir2/{release}/Person?_id={uuid}

Search through serviceRequest endpoint by Occurrence when service should occurance

Searches for serviceRequest based on to occurrent date eg) /ws/fhir2/{release}/ServiceRequest?occurrence={date}

Search through serviceRequest endpoint by Practitioner family

Searches for serviceRequest based on the Practitioner's family name eg) /ws/fhir2/{release}/ServiceRequest?requester:Practitioner.family={familyName}

Search through serviceRequest endpoint by Practitioner given

Searches for serviceRequest based on the Practitioner's given name(s) eg) /ws/fhir2/{release}/ServiceRequest?requester:Practitioner.given={givenName}

Search through serviceRequest endpoint by Practitioner identifier

Searches for serviceRequest by the Practitioner identifier eg) /ws/fhir2/{release}/ServiceRequest?requester:Practitioner.identifier={identifier}

Search through serviceRequest endpoint by Practitioner name

Searches for serviceRequest based on the Practitioner's full or partial name eg) /ws/fhir2/{release}/ServiceRequest?requester:Practitioner.name={name}

Search through serviceRequest endpoint by Practitioner uuid

Searches for serviceRequest by Practitioner uuid who requested the service eg) /ws/fhir2/{release}/ServiceRequest?requester:Practitioner={uuid}

Search through serviceRequest endpoint by concept code

Searches for serviceRequest based on the serviceRequest concept code eg) /ws/fhir2/{release}/ServiceRequest?code={code}

Search through serviceRequest endpoint by encounter uuid

Searches for serviceRequest based on the serviceRequest encounter Uuid eg) /ws/fhir2/{release}/ServiceRequest?encounter={uuid}

Search through serviceRequest endpoint by patient uuid

Searches for serviceRequest by a given patient Uuid eg) /ws/fhir2/{release}/ServiceRequest?patient={uuid}

Search through serviceRequest endpoint by service Uuid

Searches for serviceRequest based on service Uuid eg) /ws/fhir2/{release}/ServiceRequest?_id={uuid}

Search through serviceRequest endpoint by service lastUpdated field

Searches for serviceRequest based on service lastUpdated field eg) /openmrs/ws/fhir2/{release}/ServiceRequest?_lastUpdated={date}

Search through serviceRequest endpoint by subject family
Searches for serviceRequest based on the patient's family name eg) /ws/fhir2/{release}/ServiceRequest?subject:Patient.family={familyName}
Search through serviceRequest endpoint by subject given

Searches for serviceRequest based on the patient's given name(s) eg) /ws/fhir2/{release}/ServiceRequest?subject:Patient.given={givenName}

Search through serviceRequest endpoint by subject identifier

Searches for serviceRequest by the patient identifier eg) /ws/fhir2/{release}/ServiceRequest?subject:Patient.identifier={identifier}

Search through serviceRequest endpoint by subject name

Searches for serviceRequest based on the patient's full or partial name eg) /ws/fhir2/{release}/ServiceRequest?subject:Patient.name={name}

Search through serviceRequest endpoint by subject uuid

Searches for serviceRequest by a given subject eg) /ws/fhir2/{release}/ServiceRequest?subject:Patient={patientUuid}

Search through serviceRequest endpoint by the patient's family name

Searches for serviceRequest based on the patient's family name eg) /ws/fhir2/{release}/ServiceRequest?patient.family={familyName}

Search through serviceRequest endpoint by the patient's full or partial name

Searches for serviceRequest based on the patient's full or partial name eg) /ws/fhir2/{release}/ServiceRequest?patient-name={name}

Search through serviceRequest endpoint by the patient's given name

Searches for serviceRequest based on the patient's given name(s) eg) /ws/fhir2/{release}/ServiceRequest?patient.given={givenName}

Searches based on the exact UUID of the person record

Searches based on the exact UUID of the person record eg) /ws/fhir2/{release}/Observation?_id={uuid}

Searches based on the the dateCreated field for the observation record

Searches based on the the dateCreated field for the observation record eg) /ws/fhir2/{release}/Observation?_lastUpdated={date-range}

Searches for an observation group that contains an observation with the provided code

Searches for an observation group that contains an observation with the provided code eg) /ws/fhir2/{release}/Observation?has-member.code={code}

Searches for an observation whose value is a concept that matches the provided concept code

Searches for an observation whose value is a concept that matches the provided concept code eg) /ws/fhir2/{release}/Observation?value-concept={concept}

Searches for an observation whose value is a date by the specified date range.

Searches for an observation whose value is a date by the specified date range. eg) /ws/fhir2/{release}/Observation?value-date={date}

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

OMRS Group

A Group Resource is described as Cohort in Fhir2 OMRS

OMRS Medication

A FHIR Medication Resource as understood by OpenMRS

OMRS Medication Dispense

Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.

OpenMRS AllergyIntolerance

A FHIR Allergy as understood by OpenMRS

OpenMRS Diagnostic Report

DiagnosticReport resource created by a OpenMRS that representing results of diagnostic tests that are performed in a given clinical context.

OpenMRS Immunization

A FHIR Immunization Resource as understood by OpenMRS

OpenMRS Location

An OpenMRS location

OpenMRS Medication Request

A FHIR MedicationRequest as understood by OpenMRS

OpenMRS Observation

Observation resource created in OpenMRS representing a result for an order submitted by an EMR System

OpenMRS Patient

A FHIR Patient as understood by OpenMRS

OpenMRS Person

A FHIR Person as understood by OpenMRS

OpenMRS Related Person

A FHIR RelatedPerson as understood by OpenMRS Relationship

OpenMRS Service Request

Service Request Resource is represents a request for some type of procedure or diagnostic test to be performed. When fulfilled, the results of this request are represented as a DiagnosticReport resource with associated Observation resources

OpenMRS Task

A Task resource represent an activity that is to be performed,and track the completion of said activity between an OpenMRS and a FHIR2

OpenMRS condition

A FHIR Condition as understood by OpenMRS

Openmrs Encounter

A FHIR Encounter as understood by OpenMRS

Openmrs Practitioner

A FHIR Practitioner as understood by OpenMRS

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

OMRS Address

Address profile specifies the geological location details

OpenMRS Location Contact Point

An OpenMRS Location Phone Number

OpenMRS Patient Identifier

Patient Identifers as understood by OpenMRS

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Group descriptive extension

Extension for group description

OpenMRS Patient Identifier Location

OpenMRS location for which this identifier is valid

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

OpenMRS Order Code

The code for the openmrs requested in the EMR.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Encounter Type Code System

Encounter Type Coding System

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example of RelatedPerson

An example instance of the OpenMRS RelatedPerson resource.

Location Example

Example OpenMRS Location resource

OpenMRS Allergy Intolerance Example

Example OpenMRS Allergy Intolerance resource

OpenMRS Condition Resource Example

Example OMRS Condition resource

OpenMRS Encounter Resource Example

Example OpenMRS Encounter resource

OpenMRS Group Example

Example OpenMRS Group resource

OpenMRS Immunization Example

Example OpenMRS Immunization Resource

OpenMRS Medication Dispense Example

Example OpenMRS Medication Dispense resource

OpenMRS Medication Example

Example OpenMRS Medication resource

OpenMRS Medication Request Example

Example OpenMRS Medication Request resource

OpenMRS Observation Example

Example OpenMRS Observation resource

OpenMRS Patient Example

Example OpenMRS Patient resource

OpenMRS Person Example

Example OMRS Person resource

OpenMRS Practitioner Example

Practitioner Resource Example

OpenMRS ServiceRequest Example

Example OpenMRS Service Request resource

OpenMRS Task

Example OMRS Task resource

Openmrs DiagnosticReport

Example OMRS DiagnosticReport Resource

Organization example

Example organization performing a task