Capabilities
REST Capabilities Server
| Mode | Server | Documentation | The FHIR functionality defined in the CSA Directory. |
Security
| Cors | True |
| Service | Shared Service Credentials and Product OID verification |
| Description | The Directory requests are authorized via basic shared service credentials defined in ECP and tokenized for use in the Authorization header as well as product and/or device privilege verification via the x-user-identitiy header. |
Resource Interactions
| Resource Type | Profile | Supported Profiles | Read | Vread | Create | Update | Delete | Patch | HistoryInstance | SearchType | ConditionalCreate | ConditionalUpdate | ConditionalDelete |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Account | Account | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| CodeSystem | CodeSystem | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |||||
| Device | Device | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Encounter | Encounter | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Group | Group | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Location | Location | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Observation | Observation | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Organization | Organization | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Patient | Patient | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Practitioner | Practitioner | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| PractitionerRole | PractitionerRole | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| Schedule | Schedule | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |
| StructureDefinition | StructureDefinition | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported | |||||
| ValueSet | ValueSet | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | Not Supported | NotSupported |
Global Operations
| Operation | Reference | Level |
|---|---|---|
| validate | Validate | Supported |
| graphql | Graphql | Supported |
| versions | Versions | Supported |
Global Search Parameters
| Name | Type | Documentation | Level |
|---|---|---|---|
| _type | token | Type of resource (when doing cross-resource search | Supported |
| _sort | token | How to sort the resources when returning | Supported |
| _count | number | How many resources to return | Supported |
| _include | token | Control over returning additional resources (see spec) | Supported |
| _revinclude | token | Control over returning additional resources (see spec) | Supported |
| _contained | token | Managing search into contained resources | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| _security | token | Security Labels applied to this resource | Supported |
| _profile | uri | Profiles this resource claims to conform to | Supported |
| _tag | token | Tags applied to this resource | Supported |
| _source | uri | Identifies where the resource comes from | Supported |
| _id | token | Logical id of this artifact | Supported |
Search Parameters per resource type
Account
| Name | Type | Documentation | Level |
|---|---|---|---|
| owner | reference | Entity managing the Account | Supported |
| identifier | token | Account number | Supported |
| period | date | Transaction window | Supported |
| patient | reference | The entity that caused the expenses | Supported |
| subject | reference | The entity that caused the expenses | Supported |
| name | string | Human-readable label | Supported |
| type | token | E.g. patient, expense, depreciation | Supported |
| status | token | active | inactive | entered-in-error | on-hold | unknown | Supported |
Supported Includes:
- Account.owner
- Account.patient
- Account.subject
Supported Reverse Includes:
- ChargeItem.account
- Encounter.account
- Invoice.account
CodeSystem
| Name | Type | Documentation | Level |
|---|---|---|---|
| date | date | The code system publication date | Supported |
| identifier | token | External identifier for the code system | Supported |
| code | token | A code defined in the code system | Supported |
| context-type-value | composite | A use context type and value assigned to the code system | Supported |
| content-mode | token | not-present | example | fragment | complete | supplement | Supported |
| jurisdiction | token | Intended jurisdiction for the code system | Supported |
| description | string | The description of the code system | Supported |
| context-type | token | A type of use context assigned to the code system | Supported |
| language | token | A language in which a designation is provided | Supported |
| title | string | The human-friendly name of the code system | Supported |
| version | token | The business version of the code system | Supported |
| url | uri | The uri that identifies the code system | Supported |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the code system | Supported |
| supplements | reference | Find code system supplements for the referenced code system | Supported |
| system | uri | The system for any codes defined by this code system (same as 'url') | Supported |
| context | token | A use context assigned to the code system | Supported |
| name | string | Computationally friendly name of the code system | Supported |
| publisher | string | Name of the publisher of the code system | Supported |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the code system | Supported |
| status | token | The current status of the code system | Supported |
Supported Includes:
- CodeSystem.supplements
Supported Reverse Includes:
- CodeSystem.supplements
Device
| Name | Type | Documentation | Level |
|---|---|---|---|
| udi-di | string | The udi Device Identifier (DI) | Supported |
| identifier | token | Instance id from manufacturer, owner, and others | Supported |
| udi-carrier | string | UDI Barcode (RFID or other technology) string in *HRF* format. | Supported |
| device-name | string | A server defined search that may match any of the string fields in Device.deviceName or Device.type. | Supported |
| patient | reference | Patient information, if the resource is affixed to a person | Supported |
| organization | reference | The organization responsible for the device | Supported |
| location | reference | A location, where the resource is found | Supported |
| model | string | The model of the device | Supported |
| type | token | The type of the device | Supported |
| url | uri | Network address to contact device | Supported |
| manufacturer | string | The manufacturer of the device | Supported |
| status | token | active | inactive | entered-in-error | unknown | Supported |
Supported Includes:
- Device.patient
- Device.organization
- Device.location
Supported Reverse Includes:
- Account.patient
- Account.subject
- AdverseEvent.substance
- Appointment.practitioner
- Appointment.actor
- Appointment.patient
- Appointment.location
- AppointmentResponse.actor
- AppointmentResponse.practitioner
- AppointmentResponse.patient
- AppointmentResponse.location
- AuditEvent.agent
- AuditEvent.source
- AuditEvent.patient
- CarePlan.performer
- ChargeItem.enterer
- ChargeItem.performer-actor
- Claim.detail-udi
- Claim.procedure-udi
- Claim.subdetail-udi
- Claim.item-udi
- ClinicalUseDefinition.product
- ClinicalUseDefinition.subject
- Communication.sender
- Communication.recipient
- CommunicationRequest.requester
- CommunicationRequest.sender
- CommunicationRequest.recipient
- Composition.author
- Consent.actor
- DetectedIssue.author
- DeviceMetric.parent
- DeviceMetric.source
- DeviceRequest.requester
- DeviceRequest.performer
- DeviceRequest.subject
- DeviceRequest.patient
- DeviceRequest.device
- DeviceUseStatement.device
- DiagnosticReport.subject
- DiagnosticReport.patient
- DocumentManifest.author
- DocumentManifest.subject
- DocumentManifest.patient
- DocumentReference.subject
- DocumentReference.patient
- DocumentReference.author
- ExplanationOfBenefit.detail-udi
- ExplanationOfBenefit.procedure-udi
- ExplanationOfBenefit.subdetail-udi
- ExplanationOfBenefit.item-udi
- Flag.author
- Group.member
- ImagingStudy.performer
- ImagingStudy.subject
- ImagingStudy.patient
- Invoice.participant
- List.patient
- List.subject
- List.source
- MeasureReport.patient
- MeasureReport.subject
- Media.subject
- Media.operator
- Media.patient
- Media.device
- MedicationAdministration.performer
- MedicationAdministration.device
- MedicationDispense.performer
- MedicationRequest.requester
- MedicationRequest.intended-performer
- MessageHeader.target
- Observation.subject
- Observation.patient
- Observation.device
- Procedure.performer
- Provenance.agent
- QuestionnaireResponse.author
- RequestGroup.author
- RequestGroup.participant
- RiskAssessment.performer
- Schedule.actor
- ServiceRequest.requester
- ServiceRequest.performer
- ServiceRequest.subject
- ServiceRequest.patient
- Specimen.patient
- Specimen.subject
- SupplyRequest.requester
- Task.owner
- Task.requester
Encounter
| Name | Type | Documentation | Level |
|---|---|---|---|
| date | date | A date within the period the Encounter lasted | Supported |
| identifier | token | Identifier(s) by which this encounter is known | Supported |
| participant-type | token | Role of participant in encounter | Supported |
| practitioner | reference | Persons involved in the encounter other than the patient | Supported |
| subject | reference | The patient or group present at the encounter | Supported |
| episode-of-care | reference | Episode(s) of care that this encounter should be recorded against | Supported |
| length | quantity | Length of encounter in days | Supported |
| diagnosis | reference | The diagnosis or procedure relevant to the encounter | Supported |
| appointment | reference | The appointment that scheduled this encounter | Supported |
| part-of | reference | Another Encounter this encounter is part of | Supported |
| type | token | Specific type of encounter | Supported |
| participant | reference | Persons involved in the encounter other than the patient | Supported |
| reason-code | token | Coded reason the encounter takes place | Supported |
| based-on | reference | The ServiceRequest that initiated this encounter | Supported |
| patient | reference | The patient or group present at the encounter | Supported |
| reason-reference | reference | Reason the encounter takes place (reference) | Supported |
| location-period | date | Time period during which the patient was present at the location | Supported |
| location | reference | Location the encounter takes place | Supported |
| service-provider | reference | The organization (facility) responsible for this encounter | Supported |
| special-arrangement | token | Wheelchair, translator, stretcher, etc. | Supported |
| class | token | Classification of patient encounter | Supported |
| account | reference | The set of accounts that may be used for billing for this Encounter | Supported |
| status | token | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | Supported |
Supported Includes:
- Encounter.practitioner
- Encounter.subject
- Encounter.episode-of-care
- Encounter.diagnosis
- Encounter.appointment
- Encounter.part-of
- Encounter.participant
- Encounter.based-on
- Encounter.patient
- Encounter.reason-reference
- Encounter.location
- Encounter.service-provider
- Encounter.account
Supported Reverse Includes:
- CarePlan.encounter
- CareTeam.encounter
- ChargeItem.context
- Claim.encounter
- ClinicalImpression.encounter
- Communication.encounter
- CommunicationRequest.encounter
- Composition.encounter
- Condition.encounter
- DeviceRequest.encounter
- DiagnosticReport.encounter
- DocumentReference.encounter
- Encounter.part-of
- ExplanationOfBenefit.encounter
- Flag.encounter
- ImagingStudy.encounter
- List.encounter
- Media.encounter
- MedicationAdministration.context
- MedicationDispense.context
- MedicationRequest.encounter
- MedicationStatement.context
- NutritionOrder.encounter
- Observation.encounter
- Procedure.encounter
- QuestionnaireResponse.encounter
- RequestGroup.encounter
- RiskAssessment.encounter
- ServiceRequest.encounter
- Task.encounter
- VisionPrescription.encounter
Group
| Name | Type | Documentation | Level |
|---|---|---|---|
| actual | token | Descriptive or actual | Supported |
| identifier | token | Unique id | Supported |
| characteristic-value | composite | A composite of both characteristic and value | Supported |
| managing-entity | reference | Entity that is the custodian of the Group's definition | Supported |
| code | token | The kind of resources contained | Supported |
| member | reference | Reference to the group member | Supported |
| exclude | token | Group includes or excludes | Supported |
| type | token | The type of resources the group contains | Supported |
| value | token | Value held by characteristic | Supported |
| characteristic | token | Kind of characteristic | Supported |
Supported Includes:
- Group.managing-entity
- Group.member
Supported Reverse Includes:
- AdverseEvent.subject
- CarePlan.subject
- CarePlan.patient
- CareTeam.patient
- CareTeam.subject
- ChargeItem.subject
- ChargeItem.patient
- ClinicalImpression.subject
- ClinicalImpression.patient
- Communication.subject
- Communication.patient
- Communication.recipient
- CommunicationRequest.subject
- CommunicationRequest.patient
- CommunicationRequest.recipient
- Condition.subject
- Condition.patient
- Consent.actor
- DeviceRequest.subject
- DeviceRequest.patient
- DeviceUseStatement.patient
- DeviceUseStatement.subject
- DiagnosticReport.subject
- DiagnosticReport.patient
- DocumentManifest.subject
- DocumentManifest.patient
- DocumentReference.subject
- DocumentReference.patient
- Encounter.subject
- Encounter.patient
- Flag.patient
- Flag.subject
- Goal.patient
- Goal.subject
- Group.member
- GuidanceResponse.patient
- GuidanceResponse.subject
- ImagingStudy.subject
- ImagingStudy.patient
- Invoice.subject
- Invoice.patient
- List.patient
- List.subject
- MeasureReport.patient
- MeasureReport.subject
- Media.subject
- Media.patient
- MedicationAdministration.subject
- MedicationAdministration.patient
- MedicationDispense.subject
- MedicationDispense.patient
- MedicationRequest.subject
- MedicationRequest.patient
- MedicationStatement.patient
- MedicationStatement.subject
- Observation.subject
- Observation.patient
- Procedure.subject
- Procedure.patient
- RequestGroup.subject
- RequestGroup.patient
- RiskAssessment.patient
- RiskAssessment.subject
- ServiceRequest.subject
- ServiceRequest.patient
- Specimen.patient
- Specimen.subject
Location
| Name | Type | Documentation | Level |
|---|---|---|---|
| identifier | token | An identifier for the location | Supported |
| partof | reference | A location of which this location is a part | Supported |
| address | string | A (part of the) address of the location | Supported |
| address-state | string | A state specified in an address | Supported |
| operational-status | token | Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping) | Supported |
| type | token | A code for the type of location | Supported |
| address-postalcode | string | A postal code specified in an address | Supported |
| address-country | string | A country specified in an address | Supported |
| endpoint | reference | Technical endpoints providing access to services operated for the location | Supported |
| organization | reference | Searches for locations that are managed by the provided organization | Supported |
| address-use | token | A use code specified in an address | Supported |
| name | string | A portion of the location's name or alias | Supported |
| near | special | Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, ... | Supported |
| address-city | string | A city specified in an address | Supported |
| status | token | Searches for locations with a specific kind of status | Supported |
Supported Includes:
- Location.partof
- Location.endpoint
- Location.organization
Supported Reverse Includes:
- Account.patient
- Account.subject
- AdverseEvent.location
- Appointment.practitioner
- Appointment.actor
- Appointment.patient
- Appointment.location
- AppointmentResponse.actor
- AppointmentResponse.practitioner
- AppointmentResponse.patient
- AppointmentResponse.location
- Claim.facility
- Contract.domain
- CoverageEligibilityRequest.facility
- Device.location
- DeviceRequest.subject
- DeviceRequest.patient
- DiagnosticReport.subject
- DiagnosticReport.patient
- Encounter.location
- ExplanationOfBenefit.facility
- Flag.patient
- Flag.subject
- HealthcareService.coverage-area
- HealthcareService.location
- Immunization.location
- List.patient
- List.subject
- Location.partof
- MeasureReport.patient
- MeasureReport.subject
- MeasureReport.reporter
- Media.subject
- Media.patient
- MedicationDispense.destination
- Observation.subject
- Observation.patient
- OrganizationAffiliation.location
- PractitionerRole.location
- Procedure.location
- Provenance.location
- RegulatedAuthorization.subject
- ResearchStudy.site
- Schedule.actor
- ServiceRequest.subject
- ServiceRequest.patient
- Specimen.patient
- Specimen.subject
- SupplyRequest.subject
Observation
| Name | Type | Documentation | Level |
|---|---|---|---|
| date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period | Supported |
| combo-data-absent-reason | token | The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing. | Supported |
| code | token | The code of the observation type | Supported |
| combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components | Supported |
| component-data-absent-reason | token | The reason why the expected value in the element Observation.component.value[x] is missing. | Supported |
| subject | reference | The subject that the observation is about | Supported |
| value-concept | token | The value of the observation, if the value is a CodeableConcept | Supported |
| value-date | date | The value of the observation, if the value is a date or period of time | Supported |
| derived-from | reference | Related measurements the observation is made from | Supported |
| focus | reference | The focus of an observation when the focus is not the patient of record. | Supported |
| part-of | reference | Part of referenced event | Supported |
| has-member | reference | Related resource that belongs to the Observation group | Supported |
| code-value-string | composite | Code and string value parameter pair | Supported |
| component-code-value-quantity | composite | Component code and component quantity value parameter pair | Supported |
| based-on | reference | Reference to the service request. | Supported |
| code-value-date | composite | Code and date/time value parameter pair | Supported |
| patient | reference | The subject that the observation is about (if patient) | Supported |
| specimen | reference | Specimen used for this observation | Supported |
| code-value-quantity | composite | Code and quantity value parameter pair | Supported |
| component-code | token | The component code of the observation type | Supported |
| combo-code-value-concept | composite | Code and coded value parameter pair, including in components | Supported |
| value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text | Supported |
| identifier | token | The unique id for a particular observation | Supported |
| performer | reference | Who performed the observation | Supported |
| combo-code | token | The code of the observation type or component type | Supported |
| method | token | The method used for the observation | Supported |
| value-quantity | quantity | The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Supported |
| component-value-quantity | quantity | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Supported |
| data-absent-reason | token | The reason why the expected value in the element Observation.value[x] is missing. | Supported |
| combo-value-quantity | quantity | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) | Supported |
| encounter | reference | Encounter related to the observation | Supported |
| code-value-concept | composite | Code and coded value parameter pair | Supported |
| component-code-value-concept | composite | Component code and component coded value parameter pair | Supported |
| component-value-concept | token | The value of the component observation, if the value is a CodeableConcept | Supported |
| category | token | The classification of the type of observation | Supported |
| device | reference | The Device that generated the observation data. | Supported |
| combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept | Supported |
| status | token | The status of the observation | Supported |
Supported Includes:
- Observation.subject
- Observation.derived-from
- Observation.focus
- Observation.part-of
- Observation.has-member
- Observation.based-on
- Observation.patient
- Observation.specimen
- Observation.performer
- Observation.encounter
- Observation.device
Supported Reverse Includes:
- Appointment.reason-reference
- ChargeItem.service
- ClinicalImpression.finding-ref
- ClinicalImpression.investigation
- DiagnosticReport.result
- Encounter.reason-reference
- Immunization.reaction
- Immunization.reason-reference
- MedicationStatement.part-of
- Observation.derived-from
- Observation.has-member
- Procedure.part-of
- Procedure.reason-reference
- QuestionnaireResponse.part-of
Organization
| Name | Type | Documentation | Level |
|---|---|---|---|
| identifier | token | Any identifier for the organization (not the accreditation issuer's identifier) | Supported |
| partof | reference | An organization of which this organization forms a part | Supported |
| address | string | 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 | Supported |
| address-state | string | A state specified in an address | Supported |
| active | token | Is the Organization record active | Supported |
| type | token | A code for the type of organization | Supported |
| address-postalcode | string | A postal code specified in an address | Supported |
| address-country | string | A country specified in an address | Supported |
| endpoint | reference | Technical endpoints providing access to services operated for the organization | Supported |
| phonetic | string | A portion of the organization's name using some kind of phonetic matching algorithm | Supported |
| address-use | token | A use code specified in an address | Supported |
| name | string | A portion of the organization's name or alias | Supported |
| address-city | string | A city specified in an address | Supported |
Supported Includes:
- Organization.partof
- Organization.endpoint
Supported Reverse Includes:
- Account.owner
- Account.patient
- Account.subject
- AuditEvent.agent
- AuditEvent.source
- AuditEvent.patient
- Basic.author
- CarePlan.performer
- CareTeam.participant
- ChargeItem.performing-organization
- ChargeItem.enterer
- ChargeItem.performer-actor
- ChargeItem.requesting-organization
- Claim.care-team
- Claim.payee
- Claim.provider
- Claim.insurer
- ClaimResponse.insurer
- ClaimResponse.requestor
- Communication.sender
- Communication.recipient
- CommunicationRequest.requester
- CommunicationRequest.sender
- CommunicationRequest.recipient
- Composition.author
- Composition.attester
- Consent.actor
- Consent.organization
- Consent.consentor
- Contract.authority
- Contract.signer
- Coverage.payor
- Coverage.policy-holder
- CoverageEligibilityRequest.provider
- CoverageEligibilityResponse.insurer
- CoverageEligibilityResponse.requestor
- Device.organization
- DeviceRequest.requester
- DeviceRequest.performer
- DiagnosticReport.performer
- DiagnosticReport.subject
- DiagnosticReport.patient
- DiagnosticReport.results-interpreter
- DocumentManifest.author
- DocumentManifest.recipient
- DocumentReference.authenticator
- DocumentReference.custodian
- DocumentReference.author
- Encounter.service-provider
- Endpoint.organization
- EpisodeOfCare.organization
- ExplanationOfBenefit.care-team
- ExplanationOfBenefit.payee
- ExplanationOfBenefit.provider
- Flag.author
- Flag.patient
- Flag.subject
- Goal.patient
- Goal.subject
- Group.managing-entity
- HealthcareService.organization
- ImagingStudy.performer
- Immunization.performer
- Immunization.manufacturer
- InsurancePlan.owned-by
- InsurancePlan.administered-by
- Invoice.issuer
- Invoice.participant
- Invoice.recipient
- Linkage.author
- Location.organization
- MeasureReport.reporter
- Media.operator
- Medication.manufacturer
- MedicationDispense.performer
- MedicationKnowledge.manufacturer
- MedicationRequest.requester
- MedicationRequest.intended-dispenser
- MedicationRequest.intended-performer
- MedicationStatement.source
- MedicinalProductDefinition.contact
- MessageHeader.receiver
- MessageHeader.sender
- MessageHeader.responsible
- Observation.subject
- Observation.patient
- Observation.performer
- Organization.partof
- OrganizationAffiliation.primary-organization
- OrganizationAffiliation.network
- OrganizationAffiliation.participating-organization
- Patient.general-practitioner
- Patient.organization
- PaymentNotice.provider
- PaymentReconciliation.payment-issuer
- PaymentReconciliation.requestor
- Person.organization
- PractitionerRole.organization
- Procedure.performer
- Provenance.agent
- QuestionnaireResponse.author
- RegulatedAuthorization.subject
- RegulatedAuthorization.holder
- ResearchStudy.sponsor
- ServiceRequest.requester
- ServiceRequest.performer
- SupplyDelivery.supplier
- SupplyRequest.requester
- SupplyRequest.subject
- SupplyRequest.supplier
- Task.owner
- Task.requester
Patient
| Name | Type | Documentation | Level |
|---|---|---|---|
| given | string | A portion of the given name of the patient | Supported |
| identifier | token | A patient identifier | Supported |
| address | string | 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 | Supported |
| birthdate | date | The patient's date of birth | Supported |
| deceased | token | This patient has been marked as deceased, or has a death date entered | Supported |
| address-state | string | A state specified in an address | Supported |
| gender | token | Gender of the patient | Supported |
| general-practitioner | reference | Patient's nominated general practitioner, not the organization that manages the record | Supported |
| link | reference | All patients linked to the given patient | Supported |
| active | token | Whether the patient record is active | Supported |
| language | token | Language code (irrespective of use value) | Supported |
| address-postalcode | string | A postalCode specified in an address | Supported |
| address-country | string | A country specified in an address | Supported |
| death-date | date | The date of death has been provided and satisfies this search value | Supported |
| phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Supported |
| phone | token | A value in a phone contact | Supported |
| organization | reference | The organization that is the custodian of the patient record | Supported |
| address-use | token | A use code specified in an address | Supported |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Supported |
| telecom | token | The value in any kind of telecom details of the patient | Supported |
| address-city | string | A city specified in an address | Supported |
| family | string | A portion of the family name of the patient | Supported |
| token | A value in an email contact | Supported |
Supported Includes:
- Patient.general-practitioner
- Patient.link
- Patient.organization
Supported Reverse Includes:
- Account.patient
- Account.subject
- AdverseEvent.recorder
- AdverseEvent.subject
- AllergyIntolerance.recorder
- AllergyIntolerance.asserter
- AllergyIntolerance.patient
- Appointment.practitioner
- Appointment.actor
- Appointment.patient
- Appointment.location
- AppointmentResponse.actor
- AppointmentResponse.practitioner
- AppointmentResponse.patient
- AppointmentResponse.location
- AuditEvent.agent
- AuditEvent.source
- AuditEvent.patient
- Basic.author
- BodyStructure.patient
- CarePlan.performer
- CarePlan.subject
- CarePlan.patient
- CareTeam.patient
- CareTeam.subject
- CareTeam.participant
- ChargeItem.subject
- ChargeItem.patient
- ChargeItem.enterer
- ChargeItem.performer-actor
- Claim.payee
- Claim.patient
- ClaimResponse.patient
- ClinicalImpression.subject
- ClinicalImpression.patient
- Communication.subject
- Communication.sender
- Communication.patient
- Communication.recipient
- CommunicationRequest.requester
- CommunicationRequest.subject
- CommunicationRequest.sender
- CommunicationRequest.patient
- CommunicationRequest.recipient
- Composition.author
- Composition.attester
- Condition.subject
- Condition.asserter
- Condition.patient
- Consent.actor
- Consent.patient
- Consent.consentor
- Contract.signer
- Coverage.payor
- Coverage.subscriber
- Coverage.beneficiary
- Coverage.patient
- Coverage.policy-holder
- CoverageEligibilityRequest.patient
- CoverageEligibilityResponse.patient
- DetectedIssue.patient
- Device.patient
- DeviceRequest.performer
- DeviceRequest.subject
- DeviceRequest.patient
- DeviceUseStatement.patient
- DeviceUseStatement.subject
- DiagnosticReport.subject
- DiagnosticReport.patient
- DocumentManifest.author
- DocumentManifest.subject
- DocumentManifest.patient
- DocumentManifest.recipient
- DocumentReference.subject
- DocumentReference.patient
- DocumentReference.author
- Encounter.subject
- Encounter.patient
- EnrollmentRequest.patient
- EnrollmentRequest.subject
- EpisodeOfCare.patient
- ExplanationOfBenefit.payee
- ExplanationOfBenefit.patient
- FamilyMemberHistory.patient
- Flag.author
- Flag.patient
- Flag.subject
- Goal.patient
- Goal.subject
- Group.member
- GuidanceResponse.patient
- GuidanceResponse.subject
- ImagingStudy.performer
- ImagingStudy.subject
- ImagingStudy.patient
- Immunization.patient
- ImmunizationEvaluation.patient
- ImmunizationRecommendation.patient
- Invoice.subject
- Invoice.participant
- Invoice.patient
- Invoice.recipient
- List.patient
- List.subject
- List.source
- MeasureReport.patient
- MeasureReport.subject
- Media.subject
- Media.operator
- Media.patient
- MedicationAdministration.performer
- MedicationAdministration.subject
- MedicationAdministration.patient
- MedicationDispense.performer
- MedicationDispense.receiver
- MedicationDispense.subject
- MedicationDispense.patient
- MedicationRequest.requester
- MedicationRequest.subject
- MedicationRequest.intended-performer
- MedicationRequest.patient
- MedicationStatement.patient
- MedicationStatement.subject
- MedicationStatement.source
- MolecularSequence.patient
- NutritionOrder.patient
- Observation.subject
- Observation.patient
- Observation.performer
- Patient.link
- Person.practitioner
- Person.link
- Person.relatedperson
- Person.patient
- Procedure.performer
- Procedure.subject
- Procedure.patient
- Provenance.agent
- QuestionnaireResponse.author
- QuestionnaireResponse.source
- RelatedPerson.patient
- RequestGroup.subject
- RequestGroup.participant
- RequestGroup.patient
- ResearchSubject.individual
- ResearchSubject.patient
- RiskAssessment.patient
- RiskAssessment.subject
- Schedule.actor
- ServiceRequest.requester
- ServiceRequest.performer
- ServiceRequest.subject
- ServiceRequest.patient
- Specimen.patient
- Specimen.subject
- SupplyDelivery.patient
- SupplyRequest.requester
- SupplyRequest.subject
- Task.owner
- Task.requester
- VisionPrescription.patient
Practitioner
| Name | Type | Documentation | Level |
|---|---|---|---|
| given | string | A portion of the given name | Supported |
| identifier | token | A practitioner's Identifier | Supported |
| gender | token | Gender of the practitioner | Supported |
| active | token | Whether the practitioner record is active | Supported |
| phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm | Supported |
| phone | token | A value in a phone contact | Supported |
| name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | Supported |
| telecom | token | The value in any kind of contact | Supported |
| family | string | A portion of the family name | Supported |
Supported Reverse Includes:
- Group.member
- PractitioneRole.practitioner
PractitionerRole
| Name | Type | Documentation | Level |
|---|---|---|---|
| date | date | The period during which the practitioner is authorized to perform in these role(s) | Supported |
| identifier | token | A practitioner's Identifier | Supported |
| role | token | The practitioner can perform this role at for the organization | Supported |
| practitioner | reference | Practitioner that is able to provide the defined services for the organization | Supported |
| active | token | Whether this practitioner role record is in active use | Supported |
| phone | token | A value in a phone contact | Supported |
| location | reference | One of the locations at which this practitioner provides care | Supported |
| telecom | token | The value in any kind of contact | Supported |
Supported Includes:
- PractitionerRole.practitioner
- PractitionerRole.endpoint
- PractitionerRole.service
- PractitionerRole.organization
- PractitionerRole.location
Supported Reverse Includes:
- Group.member
Schedule
| Name | Type | Documentation | Level |
|---|---|---|---|
| actor | reference | The individual(HealthcareService, Practitioner, Location, ...) to find a Schedule for | Supported |
| date | date | Search for Schedule resources that have a period that contains this date specified | Supported |
| identifier | token | A Schedule Identifier | Supported |
| specialty | token | Type of specialty needed | Supported |
| service-category | token | High-level category | Supported |
| service-type | token | The type of appointments that can be booked into associated slot(s) | Supported |
| active | token | Is the schedule in active use | Supported |
Supported Includes:
- Schedule.actor
Supported Reverse Includes:
- Slot.schedule
StructureDefinition
| Name | Type | Documentation | Level |
|---|---|---|---|
| date | date | The structure definition publication date | Supported |
| context-type-value | composite | A use context type and value assigned to the structure definition | Supported |
| jurisdiction | token | Intended jurisdiction for the structure definition | Supported |
| description | string | The description of the structure definition | Supported |
| context-type | token | A type of use context assigned to the structure definition | Supported |
| experimental | token | For testing purposes, not real usage | Supported |
| title | string | The human-friendly name of the structure definition | Supported |
| type | uri | Type defined or constrained by this structure | Supported |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the structure definition | Supported |
| path | token | A path that is constrained in the StructureDefinition | Supported |
| base-path | token | Path that identifies the base element | Supported |
| context | token | A use context assigned to the structure definition | Supported |
| keyword | token | A code for the StructureDefinition | Supported |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the structure definition | Supported |
| identifier | token | External identifier for the structure definition | Supported |
| valueset | reference | A vocabulary binding reference | Supported |
| kind | token | primitive-type | complex-type | resource | logical | Supported |
| abstract | token | Whether the structure is abstract | Supported |
| version | token | The business version of the structure definition | Supported |
| url | uri | The uri that identifies the structure definition | Supported |
| ext-context | token | The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text | Supported |
| name | string | Computationally friendly name of the structure definition | Supported |
| publisher | string | Name of the publisher of the structure definition | Supported |
| derivation | token | specialization | constraint - How relates to base definition | Supported |
| base | reference | Definition that this type is constrained/specialized from | Supported |
| status | token | The current status of the structure definition | Supported |
Supported Includes:
- StructureDefinition.valueset
- StructureDefinition.base
Supported Reverse Includes:
- CapabilityStatement.resource-profile
- CapabilityStatement.supported-profile
- ImplementationGuide.global
- OperationDefinition.input-profile
- OperationDefinition.output-profile
- StructureDefinition.base
ValueSet
| Name | Type | Documentation | Level |
|---|---|---|---|
| date | date | The value set publication date | Supported |
| identifier | token | External identifier for the value set | Supported |
| code | token | This special parameter searches for codes in the value set. See additional notes on the ValueSet resource | Supported |
| context-type-value | composite | A use context type and value assigned to the value set | Supported |
| jurisdiction | token | Intended jurisdiction for the value set | Supported |
| description | string | The description of the value set | Supported |
| context-type | token | A type of use context assigned to the value set | Supported |
| title | string | The human-friendly name of the value set | Supported |
| version | token | The business version of the value set | Supported |
| url | uri | The uri that identifies the value set | Supported |
| expansion | uri | Identifies the value set expansion (business identifier) | Supported |
| reference | uri | A code system included or excluded in the value set or an imported value set | Supported |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the value set | Supported |
| context | token | A use context assigned to the value set | Supported |
| name | string | Computationally friendly name of the value set | Supported |
| publisher | string | Name of the publisher of the value set | Supported |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the value set | Supported |
| status | token | The current status of the value set | Supported |
Supported Reverse Includes:
- ConceptMap.source
- ConceptMap.source-uri
- ConceptMap.target-uri
- ConceptMap.target
- StructureDefinition.valueset