MediRecords FHIR Implementation Guide
1.4.0 - release

MediRecords FHIR Implementation Guide - Local Development build (v1.4.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: MediRecords FHIR Capability API Statement

Official URL: https://fhir.medirecords.com/CapabilityStatement/mr-capability Version: 1.4.0
Active as of 2022-04-21 Responsible: MediRecords Computable Name: MRCapability

MediRecords FHIR API Capability Statement

Introduction

The capability statatement below indicates the profiles and operations each resource supports.

OpenAPI Definition

The following links reference an OpenAPI definition of the MediRecords FHIR API, which can be used to import into OpenEHR cmpatible editor such as https://editor.swagger.io/.

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 1.4.0
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: Thu Apr 21 00:00:00 GMT 2022
  • Published by: MediRecords

Note 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.

FHIR RESTful Capabilities

Mode: server

MediRecords FHIR Capability Statement

Security
Enable CORS: no
Security services supported: OAuth

OAuth 2.0 using resource owner password flow

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
Patienthttps://fhir.medirecords.com/StructureDefinition/mr-patient-coreyyyyy_count, active, address-city, birthdate, family, gender, given, identifier, organization, phone, telecom
RelatedPersonhttps://fhir.medirecords.com/StructureDefinition/mr-related-person-coreyyyyy_count, email, name, patient, phone, relationship, telecom
Practitionerhttps://fhir.medirecords.com/StructureDefinition/mr-practitioner-corey
Organizationhttps://fhir.medirecords.com/StructureDefinition/mr-organisation-corey
PractitionerRolehttps://fhir.medirecords.com/StructureDefinition/mr-practitioner-role-corey
HealthcareServicehttps://fhir.medirecords.com/StructureDefinition/mr-healthcare-service-corey
Encounterhttps://fhir.medirecords.com/StructureDefinition/mr-encounter-coreyyyyy_count, class, date, patient, practitioner, reason-code, service-provider, statusEncounter.subject, Encounter.participant.individual
AllergyIntolerancehttps://fhir.medirecords.com/StructureDefinition/mr-allergy-intoleranceyyyyy_count, asserter, code, manifestation, patient, severity
Conditionhttps://fhir.medirecords.com/StructureDefinition/mr-condition-coreyyyyy_count, abatement-date, asserter, clinical-status, code, onset-date, patient, severity
FamilyMemberHistoryhttps://fhir.medirecords.com/StructureDefinition/mr-family-member-historyyyyyy_count, code, patient, relationship, status
Immunizationhttps://fhir.medirecords.com/StructureDefinition/mr-immunisationyy_count, date, lot-number, patient, performer, status, vaccine-code
MedicationRequesthttps://fhir.medirecords.com/StructureDefinition/mr-medication-requestyy_count, authoredon, code, patient, priority, requester, status
ObservationSupported profiles:
  MR Observation Vital Sign Body Mass Index
  MR Observation Vital Sign Body Height
  MR Observation Vital Sign Body Length
  MR Observation Vital Sign Body Weight
  MR Observation Vital Sign Head Circumference
  MR Observation Vital Sign Heart Rate
  MR Observation Vital Sign Oxygen Saturation
  MR Observation Vital Sign Respiratory Rate
yy_count, patient, performer, category, code, date, status

Resource Conformance: SHALLPatient

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support create, search-type, read, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLactivetoken
SHALLaddress-citystring
SHALLbirthdatedate
SHALLfamilystring
SHALLgendertoken
SHALLgivenstring
SHALLidentifiertoken
SHALLorganizationreference
SHALLphonetoken
SHALLtelecomtoken
 

Resource Conformance: SHALLRelatedPerson

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, search-type, read, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLemailtoken
SHALLnamestring
SHALLphonetoken
SHALLrelationshiptoken
SHALLtelecomtoken
SHALLpatientreference

The patient parameter must be specified.

 

Resource Conformance: supportedPractitioner

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supportedOrganization

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supportedPractitionerRole

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supportedHealthcareService

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: SHALLEncounter

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type, read, create, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLclasstoken
SHALLdatedate
SHALLpatientreference
SHALLpractitionerreference
SHALLreason-codetoken
SHALLservice-providerreference
SHALLstatustoken
 

Resource Conformance: supportedAllergyIntolerance

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, search-type, read, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLasserterreference
SHALLcodetoken

parameter with :text modifier supported only

SHALLmanifestationtoken

parameter with :text modifier supported only

SHALLpatientreference
SHALLseveritytoken
 

Resource Conformance: supportedCondition

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, create, read, update, delete.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLabatement-datedate
SHALLasserterreference
SHALLclinical-statustoken
SHALLcodetoken
SHALLonset-datedate
SHALLpatientreference
SHALLseveritytoken
 

Resource Conformance: supportedFamilyMemberHistory

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read, create, delete, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLcodetoken
SHALLpatientreference
SHALLrelationshiptoken
SHALLstatustoken
 

Resource Conformance: supportedImmunization

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLdatedate
SHALLlot-numberstring
SHALLpatientreference
SHALLperformerreference
SHALLstatustoken
SHALLvaccine-codetoken
 

Resource Conformance: supportedMedicationRequest

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_countnumber
SHALLauthoredondate
SHALLcodetoken
SHALLpatientreference
SHALLprioritytoken
SHALLrequesterreference
SHALLstatustoken