Implementation Guide
25.0.0 - R4 APIs
Publish Box goes here
| Official URL: https://docs.mydata.athenahealth.com/fhir-r4/CapabilityStatement-metadata-aFlow.html | Version: 25.0.0 | |||
| Active as of 2022-01-13 | Computable Name: | |||
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml, application/fhir+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverCertificates, SMART-on-FHIR, OAuthtransactioninteraction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | D | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-allergy-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, category, clinical-status, code, criticality, date, date-fromnow, encounter, encounter-or-historical, enddate, enddate-fromnow, identifier, manifestation, onset-or-approximate, patient, recorder, start, start-fromnow, verification-status | AllergyIntolerance:*, AllergyIntolerance:encounter, AllergyIntolerance:encounter-or-historical, AllergyIntolerance:patient, AllergyIntolerance:recorder | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| Appointment | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-appointment-profile | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, actor, date, date-fromnow, identifier, location, part-status, patient, practitioner, reason-code, service-type, status | Appointment:*, Appointment:actor, Appointment:location, Appointment:patient, Appointment:practitioner, PractitionerRole:practitioner | |||
| AuditEvent | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-auditevent-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, action, agent, agent-name, date, date-fromnow, entity, outcome, type | AuditEvent:*, AuditEvent:agent, AuditEvent:entity | |||||
| Binary | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-binary-profile | y | y | y | ||||||
| CarePlan | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careplan-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, activity-reference, author, care-team, category, condition, date, date-fromnow, encounter, goal, identifier, intent, patient, status, subject | CarePlan:*, CarePlan:activity-reference, CarePlan:author, CarePlan:care-team, CarePlan:condition, CarePlan:encounter, CarePlan:goal, CarePlan:patient, CarePlan:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| CareTeam | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-careteam-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, identifier, participant, patient, status, subject | CareTeam:*, CareTeam:participant, CareTeam:patient, CareTeam:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| ClinicalImpression | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-clinicalimpressn-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, assessor, date, date-fromnow, encounter, encounter-or-historical, identifier, patient, problem, status, subject | ClinicalImpression:*, ClinicalImpression:assessor, ClinicalImpression:encounter, ClinicalImpression:encounter-or-historical, ClinicalImpression:patient, ClinicalImpression:problem, ClinicalImpression:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| ConceptMap | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-conceptmap-profile | y | y | _id, name, source-code, target-code | ||||||
| Condition | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-condition-profile | y | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, abatement-date, abatement-date-fromnow, abatement-string, asserter, category, clinical-status, code, encounter, encounter-or-historical, identifier, onset-date, onset-date-fromnow, onset-info, patient, recorded-date, recorded-date-fromnow, subject, verification-status | Condition:*, Condition:asserter, Condition:encounter, Condition:encounter-or-historical, Condition:patient, Condition:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | |
| Consent | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-consent-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, category, consentor, date, date-fromnow, encounter, encounter-or-historical, identifier, patient, scope, startdate, startdate-fromnow, status | Consent:*, Consent:consentor, Consent:encounter, Consent:encounter-or-historical, Consent:patient, PractitionerRole:practitioner | |||||
| Coverage | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-coverage-profile | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, beneficiary, class-type, class-value, identifier, patient, payor, period, period-fromnow, policy-holder, status, subscriber, type | Coverage:*, Coverage:beneficiary, Coverage:patient, Coverage:payor, Coverage:policy-holder, Coverage:subscriber | |||
| Device | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-device-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, identifier, manufacturer, model, patient, status, type, udi-carrier, udi-di | Device:*, Device:patient | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| DiagnosticReport | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-diagnosticreport-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, based-on, category, code, date, date-fromnow, encounter, issued, issued-fromnow, patient, performer, result, status, subject | DiagnosticReport:*, DiagnosticReport:based-on, DiagnosticReport:encounter, DiagnosticReport:patient, DiagnosticReport:performer, DiagnosticReport:result, DiagnosticReport:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| DocumentReference | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-documentref-profile | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, authenticator, author, category, custodian, date, date-fromnow, description, encounter, facility, identifier, patient, period, period-fromnow, relatesto, relation, status, subject, type | DocumentReference:*, DocumentReference:authenticator, DocumentReference:author, DocumentReference:custodian, DocumentReference:encounter, DocumentReference:patient, DocumentReference:relatesto, DocumentReference:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | |||
| Encounter | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-encounter-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, appointment, date, date-fromnow, identifier, location, participant, participant-type, patient, reason-code, reason-reference, status, subject, type | Encounter:*, Encounter:appointment, Encounter:location, Encounter:participant, Encounter:patient, Encounter:reason-reference, Encounter:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| Endpoint | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-endpoint-profile | y | y | _after, _before, _id, connection-type, name, organization, payload-type, status | Endpoint:*, Endpoint:organization | |||||
| FamilyMemberHistory | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-familyhistory-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, code, date, date-fromnow, identifier, patient, relationship, sex, status | FamilyMemberHistory:*, FamilyMemberHistory:patient | |||||
| Goal | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-goal-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, category, expressedBy, identifier, lifecycle-status, patient, start-date, start-date-fromnow, subject, target-date, target-date-fromnow | Goal:*, Goal:expressedBy, Goal:patient, Goal:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| Group | ||||||||||
| Immunization | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-immunization-profile | y | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, date, date-fromnow, dose-number, encounter, encounter-or-historical, identifier, location, lot-number, notgiven, patient, performer, reaction, reaction-date, reaction-date-fromnow, reason-code, series, status, status-reason, vaccine-code | Immunization:*, Immunization:encounter, Immunization:encounter-or-historical, Immunization:location, Immunization:patient, Immunization:performer, Immunization:reaction | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | |
| List | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-list-profile | y | ||||||||
| Location | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-location-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, address, address-city, address-country, address-postalcode, address-state, identifier, name, organization, partof, status | Location:*, Location:organization, Location:partof | |||||
| Media | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-media-profile | y | y | _after, _before, _id, patient, subject, encounter, created | Media:*, Media:encounter, Media:patient, Media:subject | |||||
| Medication | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medication-profile | y | y | _after, _before, _id, code, form | Medication:* | |||||
| MedicationAdministration | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medicationadmin-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, context, ddid, effective-time, effective-time-fromnow, encounter-or-historical, identifier, medication, ndc, patient, performer, reason-given, request, rxnorm, status, subject | MedicationAdministration:*, MedicationAdministration:context, MedicationAdministration:encounter-or-historical, MedicationAdministration:medication, MedicationAdministration:patient, MedicationAdministration:performer, MedicationAdministration:request, MedicationAdministration:subject, PractitionerRole:practitioner | |||||
| MedicationDispense | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-meddispense-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, code, medication, subject, patient, performer, prescription, status, type, whenhandedover, whenhandedover-fromnow | MedicationDispense:*, MedicationDispense:medication, MedicationDispense:patient, MedicationDispense:performer, MedicationDispense:prescription, MedicationDispense:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| MedicationRequest | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medrequest-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, authoredon, authoredon-fromnow, datewritten, datewritten-fromnow, ddid, encounter, identifier, intent, medication, ndc, patient, requester, rxnorm, status, subject | MedicationRequest:*, MedicationRequest:encounter, MedicationRequest:medication, MedicationRequest:patient, MedicationRequest:requester, MedicationRequest:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| MedicationStatement | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-medstatement-profile | y | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, context, ddid, effective, effective-fromnow, encounter-or-historical, identifier, medication, ndc, patient, rxnorm, source, status, subject | MedicationStatement:*, MedicationStatement:context, MedicationStatement:encounter-or-historical, MedicationStatement:medication, MedicationStatement:patient, MedicationStatement:source, MedicationStatement:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | |
| NamingSystem | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-namingsystem-profile | y | y | _id, name, value | ||||||
| Observation | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-observation-profile | y | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _recent, _security, _tag, category, code, combo-code, combo-value-concept, combo-value-quantity, component-code, component-value-quantity, date, date-fromnow, encounter, encounter-or-historical, identifier, patient, performer, specimen, status, subject, value-concept, value-quantity | Observation:*, Observation:encounter, Observation:encounter-or-historical, Observation:patient, Observation:performer, Observation:specimen, Observation:subject, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | |
| OperationDefinition | y | |||||||||
| Organization | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-organization-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, active, address, address-city, address-country, address-postalcode, address-state, identifier, name, phonetic, type | Organization:* | |||||
| Patient | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-patient-profile | y | y | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, active, address, address-city, address-country, address-postalcode, address-state, birthdate, birthdate-fromnow, death-date, death-date-fromnow, deceased, email, ethnicity, family, gender, genderIdentity, general-practitioner, given, identifier, language, mothersMaidenName, name, organization, phone, phonetic, race, sexualOrientation, telecom | Patient:*, Patient:general-practitioner, Patient:organization, PractitionerRole:practitioner | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||
| Practitioner | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitioner-profile | y | y | _after, _before, _id, active, address, address-city, address-country, address-postalcode, address-state, family, given, identifier, name, phone, phonetic, telecom | Practitioner:* | |||||
| PractitionerRole | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-practitionerrole-profile | y | y | _after, _before, _id, active, endpoint, identifier, location, organization, practitioner, role, specialty | PractitionerRole:*, PractitionerRole:endpoint, PractitionerRole:location, PractitionerRole:organization, PractitionerRole:practitioner | |||||
| Procedure | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-procedure-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, based-on, code, date, date-fromnow, encounter, identifier, patient, performer, reason-reference, status, subject | PractitionerRole:practitioner, Procedure:*, Procedure:based-on, Procedure:encounter, Procedure:patient, Procedure:performer, Procedure:reason-reference, Procedure:subject | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| Provenance | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-provenance-profile | y | y | _after, _before, _id, patient, target | ||||||
| QuestionnaireResponse | y | |||||||||
| RelatedPerson | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-relatedperson-profile | y | y | _after, _before, _id, _security, active, address-city, address-country, address-postalcode, address-state, birthdate, birthdate-fromnow, gender, identifier, patient, phone, relationship, telecom | RelatedPerson:*, RelatedPerson:patient | |||||
| ServiceRequest | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-servicerequest-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, category, code, encounter, encounter-or-historical, identifier, intent, occurrence, occurrence-fromnow, patient, performer, priority, requester, status, subject | PractitionerRole:practitioner, ServiceRequest:*, ServiceRequest:encounter, ServiceRequest:encounter-or-historical, ServiceRequest:patient, ServiceRequest:performer, ServiceRequest:requester, ServiceRequest:subject | |||||
| Specimen | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-specimen-profile | y | y | _after, _before, _id, _lastUpdated, _lastUpdated-fromnow, _security, _tag, bodysite, collected, collected-fromnow, identifier, patient, subject, type | Specimen:*, Specimen:patient, Specimen:subject | Provenance:agent, Provenance:entity, Provenance:location, Provenance:target | ||||
| StructureDefinition | y | y | ||||||||
| ValueSet | https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-valueset-profile | y | y | _id, code, name |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | category | token | food | medication | environment | biologic |
| SHALL | clinical-status | token | active | inactive | resolved |
| SHALL | code | token | Code that identifies the allergy or intolerance |
| SHALL | criticality | token | low | high | unable-to-assess |
| SHALL | date | date | Date first version of the resource instance was recorded |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | |
| SHALL | encounter-or-historical | reference | |
| SHALL | enddate | date | |
| SHALL | enddate-fromnow | quantity | |
| SHALL | identifier | token | External ids for this item |
| SHALL | manifestation | token | Clinical symptoms/signs associated with the Event |
| SHALL | onset-or-approximate | string | |
| SHALL | patient | reference | Who the sensitivity is for |
| SHALL | recorder | reference | Who recorded the sensitivity |
| SHALL | start | date | |
| SHALL | start-fromnow | quantity | |
| SHALL | verification-status | token | unconfirmed | confirmed | refuted | entered-in-error |
read, update, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | actor | reference | Any one of the individuals participating in the appointment |
| SHALL | date | date | Appointment date/time. |
| SHALL | date-fromnow | quantity | |
| SHALL | identifier | token | An Identifier of the Appointment |
| SHALL | location | reference | This location is listed in the participants of the appointment |
| SHALL | part-status | token | The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests. |
| SHALL | patient | reference | One of the individuals of the appointment is this patient |
| SHALL | practitioner | reference | One of the individuals of the appointment is this practitioner |
| SHALL | reason-code | token | Coded reason this appointment is scheduled |
| SHALL | service-type | token | The specific service that is to be performed during this appointment |
| SHALL | status | token | The overall status of the appointment |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | action | token | Type of action performed during the event |
| SHALL | agent | reference | Identifier of who |
| SHALL | agent-name | string | Human friendly name for the agent |
| SHALL | date | date | Time when the event was recorded |
| SHALL | date-fromnow | quantity | |
| SHALL | entity | reference | Specific instance of resource |
| SHALL | outcome | token | Whether the event succeeded or failed |
| SHALL | type | token | Type/identifier of event |
read, update, delete.read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | activity-reference | reference | Activity details defined in specific resource |
| SHALL | author | reference | |
| SHALL | care-team | reference | Who's involved in plan? |
| SHALL | category | token | Type of plan |
| SHALL | condition | reference | Health issues this plan addresses |
| SHALL | date | date | Time period plan covers |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | Encounter created as part of |
| SHALL | goal | reference | Desired outcome of plan |
| SHALL | identifier | token | External Ids for this plan |
| SHALL | intent | token | proposal | plan | order | option |
| SHALL | patient | reference | Who the care plan is for |
| SHALL | status | token | draft | active | suspended | completed | entered-in-error | cancelled | unknown |
| SHALL | subject | reference | Who the care plan is for |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | identifier | token | External Ids for this team |
| SHALL | participant | reference | Who is involved |
| SHALL | patient | reference | Who care team is for |
| SHALL | status | token | proposed | active | suspended | inactive | entered-in-error |
| SHALL | subject | reference | Who care team is for |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | assessor | reference | The clinician performing the assessment |
| SHALL | date | date | When the assessment was documented |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | Encounter created as part of |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | Business identifier |
| SHALL | patient | reference | Patient or group assessed |
| SHALL | problem | reference | Relevant impressions of patient state |
| SHALL | status | token | draft | completed | entered-in-error |
| SHALL | subject | reference | Patient or group assessed |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The ID of the resource |
| SHALL | name | token | Computationally friendly name of the concept map |
| SHALL | source-code | token | Identifies element being mapped |
| SHALL | target-code | token | Code that identifies the target element |
read, update, delete, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | abatement-date | date | Date-related abatements (dateTime and period) |
| SHALL | abatement-date-fromnow | quantity | |
| SHALL | abatement-string | string | Abatement as a string |
| SHALL | asserter | reference | Person who asserts this condition |
| SHALL | category | token | The category of the condition |
| SHALL | clinical-status | token | The clinical status of the condition |
| SHALL | code | token | Code for the condition |
| SHALL | encounter | reference | Encounter created as part of |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | A unique identifier of the condition record |
| SHALL | onset-date | date | Date related onsets (dateTime and Period) |
| SHALL | onset-date-fromnow | quantity | |
| SHALL | onset-info | string | Onsets as a string |
| SHALL | patient | reference | Who has the condition? |
| SHALL | recorded-date | date | Date record was first recorded |
| SHALL | recorded-date-fromnow | quantity | |
| SHALL | subject | reference | Who has the condition? |
| SHALL | verification-status | token | unconfirmed | provisional | differential | confirmed | refuted | entered-in-error |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | category | token | Classification of the consent statement - for indexing/retrieval |
| SHALL | consentor | reference | Who is agreeing to the policy and rules |
| SHALL | date | date | When this Consent was created or indexed |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | Identifier for this record (external references) |
| SHALL | patient | reference | Who the consent applies to |
| SHALL | scope | token | Which of the four areas this resource covers (extensible) |
| SHALL | startdate | date | |
| SHALL | startdate-fromnow | quantity | |
| SHALL | status | token | draft | proposed | active | rejected | inactive | entered-in-error |
read, update, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | beneficiary | reference | Covered party |
| SHALL | class-type | token | Coverage class (eg. plan, group) |
| SHALL | class-value | string | Value of the class (eg. Plan number, group number) |
| SHALL | identifier | token | The primary identifier of the insured and the coverage |
| SHALL | patient | reference | Retrieve coverages for a patient |
| SHALL | payor | reference | The identity of the insurer or party paying for services |
| SHALL | period | date | |
| SHALL | period-fromnow | quantity | |
| SHALL | policy-holder | reference | Reference to the policyholder |
| SHALL | status | token | The status of the Coverage |
| SHALL | subscriber | reference | Reference to the subscriber |
| SHALL | type | token | The kind of coverage (health plan, auto, Workers Compensation) |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | identifier | token | Instance id from manufacturer, owner, and others |
| SHALL | manufacturer | string | The manufacturer of the device |
| SHALL | model | string | The model of the device |
| SHALL | patient | reference | Patient information, if the resource is affixed to a person |
| SHALL | status | token | active | inactive | entered-in-error | unknown |
| SHALL | type | token | The type of the device |
| SHALL | udi-carrier | string | UDI Barcode (RFID or other technology) string in HRF format. |
| SHALL | udi-di | string | The udi Device Identifier (DI) |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | based-on | reference | Reference to the service request. |
| SHALL | category | token | Which diagnostic discipline/department created the report |
| SHALL | code | token | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| SHALL | date | date | The clinically relevant time of the report |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | The Encounter when the order was made |
| SHALL | issued | date | When the report was issued |
| SHALL | issued-fromnow | quantity | |
| SHALL | patient | reference | The subject of the report if a patient |
| SHALL | performer | reference | Who is responsible for the report |
| SHALL | result | reference | Link to an atomic result (observation resource) |
| SHALL | status | token | The status of the report |
| SHALL | subject | reference | The subject of the report |
read, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | authenticator | reference | Who/what authenticated the document |
| SHALL | author | reference | Who and/or what authored the document |
| SHALL | category | token | Categorization of document |
| SHALL | custodian | reference | Organization which maintains the document |
| SHALL | date | date | When this document reference was created |
| SHALL | date-fromnow | quantity | |
| SHALL | description | string | Human-readable description |
| SHALL | encounter | reference | Context of the document content |
| SHALL | facility | token | Kind of facility where patient was seen |
| SHALL | identifier | token | Master Version Specific Identifier |
| SHALL | patient | reference | Who/what is the subject of the document |
| SHALL | period | date | Time of service that is being documented |
| SHALL | period-fromnow | quantity | |
| SHALL | relatesto | reference | Target of the relationship |
| SHALL | relation | token | replaces | transforms | signs | appends |
| SHALL | status | token | current | superseded | entered-in-error |
| SHALL | subject | reference | Who/what is the subject of the document |
| SHALL | type | token | Kind of document (LOINC if possible) |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | appointment | reference | The appointment that scheduled this encounter |
| SHALL | date | date | A date within the period the Encounter lasted |
| SHALL | date-fromnow | quantity | |
| SHALL | identifier | token | Identifier(s) by which this encounter is known |
| SHALL | location | reference | Location the encounter takes place |
| SHALL | participant | reference | Persons involved in the encounter other than the patient |
| SHALL | participant-type | token | Role of participant in encounter |
| SHALL | patient | reference | The patient or group present at the encounter |
| SHALL | reason-code | token | Coded reason the encounter takes place |
| SHALL | reason-reference | reference | Reason the encounter takes place (reference) |
| SHALL | status | token | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| SHALL | subject | reference | The patient or group present at the encounter |
| SHALL | type | token | Specific type of encounter |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | connection-type | token | Protocol/Profile/Standard to be used with this endpoint connection |
| SHALL | name | string | A name that this endpoint can be identified by |
| SHALL | organization | reference | The organization that is managing the endpoint |
| SHALL | payload-type | token | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
| SHALL | status | token | The current status of the Endpoint (usually expected to be active) |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | code | token | A search by a condition code |
| SHALL | date | date | When history was recorded or last updated |
| SHALL | date-fromnow | quantity | |
| SHALL | identifier | token | A search by a record identifier |
| SHALL | patient | reference | The identity of a subject to list family member history items for |
| SHALL | relationship | token | A search by a relationship type |
| SHALL | sex | token | |
| SHALL | status | token | partial | completed | entered-in-error | health-unknown |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | category | token | E.g. Treatment, dietary, behavioral, etc. |
| SHALL | expressedBy | reference | |
| SHALL | identifier | token | External Ids for this goal |
| SHALL | lifecycle-status | token | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| SHALL | patient | reference | Who this goal is intended for |
| SHALL | start-date | date | When goal pursuit begins |
| SHALL | start-date-fromnow | quantity | |
| SHALL | subject | reference | Who this goal is intended for |
| SHALL | target-date | date | Reach goal on or before |
| SHALL | target-date-fromnow | quantity |
read, update, delete, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | date | date | Vaccination (non)-Administration Date |
| SHALL | date-fromnow | quantity | |
| SHALL | dose-number | number | |
| SHALL | encounter | reference | |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | Business identifier |
| SHALL | location | reference | The service delivery location or facility in which the vaccine was / was to be administered |
| SHALL | lot-number | string | Vaccine Lot Number |
| SHALL | notgiven | token | |
| SHALL | patient | reference | The patient for the vaccination record |
| SHALL | performer | reference | The practitioner or organization who played a role in the vaccination |
| SHALL | reaction | reference | Additional information on reaction |
| SHALL | reaction-date | date | When reaction started |
| SHALL | reaction-date-fromnow | quantity | |
| SHALL | reason-code | token | Reason why the vaccine was administered |
| SHALL | series | string | The series being followed by the provider |
| SHALL | status | token | Immunization event status |
| SHALL | status-reason | token | Reason why the vaccine was not administered |
| SHALL | vaccine-code | token | Vaccine Product Administered |
read.read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | address | string | A (part of the) address of the location |
| SHALL | address-city | string | A city specified in an address |
| SHALL | address-country | string | A country specified in an address |
| SHALL | address-postalcode | string | A postal code specified in an address |
| SHALL | address-state | string | A state specified in an address |
| SHALL | identifier | token | An identifier for the location |
| SHALL | name | string | A portion of the location's name or alias |
| SHALL | organization | reference | Searches for locations that are managed by the provided organization |
| SHALL | partof | reference | A location of which this location is a part |
| SHALL | status | token | Searches for locations with a specific kind of status |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource. |
| SHALL | patient | reference | The identity of a patient to list Media for. |
| SHALL | subject | reference | The identity of a patient to list Media for. |
| SHALL | encounter | reference | The identity of a encounter to list Media of. |
| SHALL | created | date | Returns Media created on this date. |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | code | token | Returns medications for a specific code |
| SHALL | form | token | Returns medications for a specific dose form |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | context | reference | Return administrations that share this encounter or episode of care |
| SHALL | ddid | token | |
| SHALL | effective-time | date | Date administration happened (or did not happen) |
| SHALL | effective-time-fromnow | quantity | |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | Return administrations with this external identifier |
| SHALL | medication | reference | Return administrations of this medication resource |
| SHALL | ndc | token | |
| SHALL | patient | reference | The identity of a patient to list administrations for |
| SHALL | performer | reference | The identity of the individual who administered the medication |
| SHALL | reason-given | token | Reasons for administering the medication |
| SHALL | request | reference | The identity of a request to list administrations from |
| SHALL | rxnorm | token | |
| SHALL | status | token | MedicationAdministration event status (for example one of active/paused/completed/nullified) |
| SHALL | subject | reference | The identity of the individual or group to list administrations for |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | code | token | Returns dispenses of this medicine code |
| SHALL | medication | reference | Returns dispenses of this medicine resource |
| SHALL | subject | reference | The identity of a patient to list dispenses for |
| SHALL | patient | reference | The identity of a patient to list dispenses for |
| SHALL | performer | reference | Returns dispenses performed by a specific individual |
| SHALL | prescription | reference | The identity of a prescription to list dispenses from |
| SHALL | status | token | Returns dispenses with a specified dispense status |
| SHALL | type | token | Returns dispenses of a specific type |
| SHALL | whenhandedover | date | Returns dispenses handed over on this date |
| SHALL | whenhandedover-fromnow | date | Returns dispenses handed over as of today |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | authoredon | date | Return prescriptions written on this date |
| SHALL | authoredon-fromnow | quantity | |
| SHALL | datewritten | date | |
| SHALL | datewritten-fromnow | quantity | |
| SHALL | ddid | token | |
| SHALL | encounter | reference | Return prescriptions with this encounter identifier |
| SHALL | identifier | token | Return prescriptions with this external identifier |
| SHALL | intent | token | Returns prescriptions with different intents |
| SHALL | medication | reference | Return prescriptions for this medication reference |
| SHALL | ndc | token | |
| SHALL | patient | reference | Returns prescriptions for a specific patient |
| SHALL | requester | reference | Returns prescriptions prescribed by this prescriber |
| SHALL | rxnorm | token | |
| SHALL | status | token | Status of the prescription |
| SHALL | subject | reference | The identity of a patient to list orders for |
read, update, delete, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | context | reference | Returns statements for a specific context (episode or episode of Care). |
| SHALL | ddid | token | |
| SHALL | effective | date | Date when patient was taking (or not taking) the medication |
| SHALL | effective-fromnow | quantity | |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | Return statements with this external identifier |
| SHALL | medication | reference | Return statements of this medication reference |
| SHALL | ndc | token | |
| SHALL | patient | reference | Returns statements for a specific patient. |
| SHALL | rxnorm | token | |
| SHALL | source | reference | Who or where the information in the statement came from |
| SHALL | status | token | Return statements that match the given status |
| SHALL | subject | reference | The identity of a patient, animal or group to list statements for |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The ID of the resource |
| SHALL | name | token | Computationally friendly name of the naming system |
| SHALL | value | string | The unique identifier |
read, update, delete, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _recent | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | category | token | The classification of the type of observation |
| SHALL | code | token | The code of the observation type |
| SHALL | combo-code | token | The code of the observation type or component type |
| SHALL | combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept |
| SHALL | 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) |
| SHALL | component-code | token | The component code of the observation type |
| SHALL | 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) |
| SHALL | date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | Encounter related to the observation |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | The unique id for a particular observation |
| SHALL | patient | reference | The subject that the observation is about (if patient) |
| SHALL | performer | reference | Who performed the observation |
| SHALL | specimen | reference | Specimen used for this observation |
| SHALL | status | token | The status of the observation |
| SHALL | subject | reference | The subject that the observation is about |
| SHALL | value-concept | token | The value of the observation, if the value is a CodeableConcept |
| SHALL | 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) |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | active | token | Is the Organization record active |
| SHALL | 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 |
| SHALL | address-city | string | A city specified in an address |
| SHALL | address-country | string | A country specified in an address |
| SHALL | address-postalcode | string | A postal code specified in an address |
| SHALL | address-state | string | A state specified in an address |
| SHALL | identifier | token | Any identifier for the organization (not the accreditation issuer's identifier) |
| SHALL | name | string | A portion of the organization's name or alias |
| SHALL | phonetic | string | A portion of the organization's name using some kind of phonetic matching algorithm |
| SHALL | type | token | A code for the type of organization |
read, update, create, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | active | token | Whether the patient record is active |
| SHALL | 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 |
| SHALL | address-city | string | A city specified in an address |
| SHALL | address-country | string | A country specified in an address |
| SHALL | address-postalcode | string | A postalCode specified in an address |
| SHALL | address-state | string | A state specified in an address |
| SHALL | birthdate | date | The patient's date of birth |
| SHALL | birthdate-fromnow | quantity | |
| SHALL | death-date | date | The date of death has been provided and satisfies this search value |
| SHALL | death-date-fromnow | quantity | |
| SHALL | deceased | token | This patient has been marked as deceased, or as a death date entered |
| SHALL | token | A value in an email contact | |
| SHALL | ethnicity | token | |
| SHALL | family | string | A portion of the family name of the patient |
| SHALL | gender | token | Gender of the patient |
| SHALL | genderIdentity | token | |
| SHALL | general-practitioner | reference | Patient's nominated general practitioner, not the organization that manages the record |
| SHALL | given | string | A portion of the given name of the patient |
| SHALL | identifier | token | A patient identifier |
| SHALL | language | token | Language code (irrespective of use value) |
| SHALL | mothersMaidenName | string | |
| SHALL | 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 |
| SHALL | organization | reference | The organization that is the custodian of the patient record |
| SHALL | phone | token | A value in a phone contact |
| SHALL | phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm |
| SHALL | race | token | |
| SHALL | sexualOrientation | token | |
| SHALL | telecom | token | The value in any kind of telecom details of the patient |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | active | token | Whether the practitioner record is active |
| SHALL | 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 |
| SHALL | address-city | string | A city specified in an address |
| SHALL | address-country | string | A country specified in an address |
| SHALL | address-postalcode | string | A postalCode specified in an address |
| SHALL | address-state | string | A state specified in an address |
| SHALL | family | string | A portion of the family name |
| SHALL | given | string | A portion of the given name |
| SHALL | identifier | token | A practitioner's Identifier |
| SHALL | 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 |
| SHALL | phone | token | A value in a phone contact |
| SHALL | phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm |
| SHALL | telecom | token | The value in any kind of contact |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | active | token | Whether this practitioner role record is in active use |
| SHALL | endpoint | reference | Technical endpoints providing access to services operated for the practitioner with this role |
| SHALL | identifier | token | A practitioner's Identifier |
| SHALL | location | reference | One of the locations at which this practitioner provides care |
| SHALL | organization | reference | The identity of the organization the practitioner represents / acts on behalf of |
| SHALL | practitioner | reference | Practitioner that is able to provide the defined services for the organization |
| SHALL | role | token | The practitioner can perform this role at for the organization |
| SHALL | specialty | token | The practitioner has this specialty at an organization |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | based-on | reference | A request for this procedure |
| SHALL | code | token | A code to identify a procedure |
| SHALL | date | date | When the procedure was performed |
| SHALL | date-fromnow | quantity | |
| SHALL | encounter | reference | Encounter created as part of |
| SHALL | identifier | token | A unique identifier for a procedure |
| SHALL | patient | reference | Search by subject - a patient |
| SHALL | performer | reference | The reference to the practitioner |
| SHALL | reason-reference | reference | The justification that the procedure was performed |
| SHALL | status | token | preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown |
| SHALL | subject | reference | Search by subject |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | patient | reference | Target Reference(s) (usually version specific) |
| SHALL | target | reference | Target Reference(s) (usually version specific) |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _security | token | |
| SHALL | active | token | Indicates if the related person record is active |
| SHALL | address-city | string | A city specified in an address |
| SHALL | address-country | string | A country specified in an address |
| SHALL | address-postalcode | string | A postal code specified in an address |
| SHALL | address-state | string | A state specified in an address |
| SHALL | birthdate | date | The Related Person's date of birth |
| SHALL | birthdate-fromnow | quantity | |
| SHALL | gender | token | Gender of the related person |
| SHALL | identifier | token | An Identifier of the RelatedPerson |
| SHALL | patient | reference | The patient this related person is related to |
| SHALL | phone | token | A value in a phone contact |
| SHALL | relationship | token | The relationship between the patient and the relatedperson |
| SHALL | telecom | token | The value in any kind of contact |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | category | token | Classification of service |
| SHALL | code | token | What is being requested/ordered |
| SHALL | encounter | reference | An encounter in which this request is made |
| SHALL | encounter-or-historical | reference | |
| SHALL | identifier | token | Identifiers assigned to this order |
| SHALL | intent | token | proposal | plan | order + |
| SHALL | occurrence | date | When service should occur |
| SHALL | occurrence-fromnow | quantity | |
| SHALL | patient | reference | Search by subject - a patient |
| SHALL | performer | reference | Requested performer |
| SHALL | priority | token | routine | urgent | asap | stat |
| SHALL | requester | reference | Who/what is requesting service |
| SHALL | status | token | draft | active | suspended | completed | entered-in-error | cancelled |
| SHALL | subject | reference | Search by subject |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _after | string | |
| SHALL | _before | string | |
| SHALL | _id | token | The ID of the resource |
| SHALL | _lastUpdated | date | |
| SHALL | _lastUpdated-fromnow | quantity | |
| SHALL | _security | token | |
| SHALL | _tag | token | |
| SHALL | bodysite | token | The code for the body site from where the specimen originated |
| SHALL | collected | date | The date the specimen was collected |
| SHALL | collected-fromnow | quantity | |
| SHALL | identifier | token | The unique identifier associated with the specimen |
| SHALL | patient | reference | The patient the specimen comes from |
| SHALL | subject | reference | The subject of the specimen |
| SHALL | type | token | The specimen type |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | The ID of the resource |
| SHALL | code | token | This special parameter searches for codes in the value set. See additional notes on the ValueSet resource |
| SHALL | name | token | Computationally friendly name of the value set |