NextGen Office FHIR R4 API
HL7 FHIR R4 (4.0.1) Patient Access API for the cloud-based NextGen Office (formerly MediTouch) EHR, coded against the US Core specification and exposing read-only USCDIv1 data. A downloadable Swagger 2.0 definition (45 paths) is published, and the live R4 CapabilityStatement advertises 26 US Core resource types. Authenticated with SMART App Launch / OpenID Connect OAuth2 via Keycloak.
NextGen Office FHIR R4 API is one of 5 APIs that NextGen Healthcare publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include FHIR, Patient Access, EHR, and SMART on FHIR. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 45 operations across 45 paths, organized into 25 resource areas, and defines 44 schemas. It is described by OpenAPI 2.0, at version 1.0.0.
Requests are made against the base URL https://fhir.meditouchehr.com/api/fhir/r4.
45 operations
45 paths
44 schemas
45 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
NextGen Office FHIR R4 API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OauthSecurity) using the accessCode flow, exposing 4 scopes.
By default, every request must be authenticated.
OauthSecurity— Access code based oauth authentication
Paths & Operations 45
Across 45 paths, the API surfaces 45 operations — 45 GET. They span 25 resource areas, including Patient, DocumentReference, Encounter, Procedure, Condition, Goal, Observation, Immunization, and 17 more. Each is listed below with its method, path, parameters, and response codes.
Patient 2
https://hl7.org/fhir/R4/patient.html
GET
/fhir/r4/Patient/{id}
Fetches a single Patient by patient Id FHIR Resource: Patient.name.given First Name Middle Name FHIR Resource: Patient.name.family Last Name FHIR Resource: Patient.name Previous Name FHIR Resource: P…
GET
/fhir/r4/Patient
Fetches a bundled resource containing the valid patients mentioned in the request parameters. FHIR Resource: Patient.name.given First Name Middle Name FHIR Resource: Patient.name.family Last Name FHI…
DocumentReference 2
https://hl7.org/fhir/R4/documentreference.html
GET
/fhir/r4/DocumentReference/{id}
Fetches a single Document Reference. A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. FHIR Resource: Doc…
GET
/fhir/r4/DocumentReference
Fetches a bundled resource containing the valid Document References for the patient mentioned in the request. FHIR Resource: DocumentReference Consultation Note Discharge Summary Note History & Physi…
Encounter 2
https://hl7.org/fhir/R4/encounter.html
GET
/fhir/r4/Encounter/{id}
Fetches a single Encounter. An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient. FHIR Resource:…
GET
/fhir/r4/Encounter
Fetches a bundled resource containing encounter data based on the provided parameters. - If only id is provided, a bundle containing a single encounter is returned. - If only patientid is provided, m…
Procedure 2
https://hl7.org/fhir/R4/procedure.html
GET
/fhir/r4/Procedure/{id}
Fetches a single Procedure by id. FHIR Resource: Procedure Procedures
GET
/fhir/r4/Procedure
Fetches a bundled resource containing the valid procedures for the patient mentioned in the request. The procedures pertain to the encounters available for the patient. FHIR Resource: Procedure Proce…
Condition 2
https://hl7.org/fhir/R4/condition.html
GET
/fhir/r4/Condition/{id}
Fetches a bundled resource containing the condition/problem associated with the provided resource id. FHIR Resource: Condition Health Concerns Problems Encounter Diagnosis
GET
/fhir/r4/Condition
Fetches a bundled resource containing the conditions/problems for the patient mentioned in the request. All conditions are mapped to SNOMED codes. FHIR Resource: Condition Health Concerns Problems En…
Goal 2
https://hl7.org/fhir/R4/goal.html
GET
/fhir/r4/Goal/{id}
Fetches a single Goal by id. FHIR Resource: Goal Patient Goals
GET
/fhir/r4/Goal
Fetches a bundled resource containing the health concern goals for the patient mentioned in the request. FHIR Resource: Goal Patient Goals
Observation 2
https://hl7.org/fhir/R4/observation.html
GET
/fhir/r4/Observation/{id}
Fetches a single observation by id. FHIR Resource: Observation Diastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Core Profile) Systolic Blood Pressure - Blood pressure systolic a…
GET
/fhir/r4/Observation
Fetches a bundled resource containing the observations. for the patient mentioned in the request. FHIR Resource: Observation Diastolic Blood Pressure - Blood pressure systolic and diastolic (FHIR Cor…
Immunization 2
https://hl7.org/fhir/R4/immunization.html
GET
/fhir/r4/Immunization/{id}
Fetches a single immunization record by id. FHIR Resource: Immunization Immunization
GET
/fhir/r4/Immunization
Fetches a bundled resource containing the immunization records for the patient mentioned in the request. All immunizations contain cvx code mapping FHIR Resource: Immunization Immunization
AllergyIntolerance 2
https://hl7.org/fhir/R4/allergyintolerance.html
GET
/fhir/r4/AllergyIntolerance/{id}
Fetches a single allergy/intolerance record by id. Allergy codes are mapped to RxNorm codes. FHIR Resource: AllergyIntolerance Substance (Drug Class) Substance (Medication) Reaction
GET
/fhir/r4/AllergyIntolerance
Fetches a bundled resource containing the allergy/intolerance records for the patient mentioned in the request. Allergy codes are mapped to RxNorm codes. FHIR Resource: AllergyIntolerance Substance (…
MedicationRequest 2
https://hl7.org/fhir/R4/medicationrequest.html
GET
/fhir/r4/MedicationRequest/{id}
Fetches a single medication prescription record by id. Medications are mapped to RxNorm codes. FHIR Resource: MedicationRequest Medications
GET
/fhir/r4/MedicationRequest
Fetches a bundled resource containing all the medication prescription records for the patient mentioned in the request. Medications are mapped to RxNorm codes. FHIR Resource: MedicationRequest Medica…
MedicationDispense 2
GET
/fhir/r4/MedicationDispense/{id}
Fetches a single medication dispense record by id. Medications are mapped to RxNorm codes. FHIR Resource: MedicationDispense Medications
GET
/fhir/r4/MedicationDispense
Returns a FHIR Bundle of MedicationDispense resources for the patient. Supported search parameters: patient (required), status (optional), revinclude (optional, for Provenance:target). Parameters ref…
MedicationAdministration 2
https://hl7.org/fhir/R4/medicationadministration.html
GET
/fhir/r4/MedicationAdministration/{id}
Fetches a single medication administration record by id. Medications are mapped to RxNorm codes. FHIR Resource: MedicationAdministration Medications
GET
/fhir/r4/MedicationAdministration
Fetches a bundled resource containing all the medication administration records for the patient mentioned in the request. Medications are mapped to RxNorm codes. FHIR Resource: MedicationAdministrati…
DiagnosticReport 2
https://hl7.org/fhir/R4/diagnosticreport.html
GET
/fhir/r4/DiagnosticReport/{id}
Fetches a single lab or radiology result by id. The observations contained in the resource. FHIR Resource: DocumentReference, DiagnosticReport Imaging Narrative Laboratory Report Narrative Pathology…
GET
/fhir/r4/DiagnosticReport
Fetches a bundled resource containing all the lab or radiology results for the patient mentioned in the request. The observations contained in the resource. FHIR Resource: DocumentReference, Diagnost…
Device 2
https://hl7.org/fhir/R4/device.html
GET
/fhir/r4/Device/{id}
Fetches a single implantable device by id. FHIR Resource: Device Unique Device Identifier(s) for Patients� Implantable Device(s)
GET
/fhir/r4/Device
Fetches a bundled resource containing all the implantable devices for the patient mentioned in the request. FHIR Resource: Device Unique Device Identifier(s) for Patients� Implantable Device(s)
CarePlan 2
https://hl7.org/fhir/R4/careplan.html
GET
/fhir/r4/CarePlan/{id}
Fetches a single plan of treatment(care plans, orders) and assessment note by id. FHIR Resource: CarePlan Assessment and Plan of Treatment
GET
/fhir/r4/CarePlan
Fetches a bundled resource containing plan of treatment(care plans, orders) and assessment notes for the patient mentioned in the request. FHIR Resource: CarePlan Assessment and Plan of Treatment
CareTeam 2
https://hl7.org/fhir/R4/careteam.html
GET
/fhir/r4/CareTeam/{id}
Fetches a single Care Team member by id. FHIR Resource: CareTeam Care Team
GET
/fhir/r4/CareTeam
Fetches a bundled resource containing details of the Care Team members for the patient or care team ID mentioned in the request. FHIR Resource: CareTeam - If only patientid is provided, care team for…
Practitioner 1
https://hl7.org/fhir/R4/practitioner.html
GET
/fhir/r4/Practitioner/{id}
Fetches a Practitioner by id. Practitioner is a person who is directly or indirectly involved in the provisioning of healthcare. FHIR Resource: Practitioner Practitioner FHIR Resource: Location Locat…
PractitionerRole 2
https://hl7.org/fhir/R4/practitionerrole.html
GET
/fhir/r4/PractitionerRole/{id}
Fetches a Practitioner Role by id. FHIR Resource: PractitionerRole Practitioner Role
GET
/fhir/r4/PractitionerRole
Fetches a bundled resource containing practitioner role data based on the provided parameters. - If practitionerid is provided, a bundle containing a practitioner role is returned. FHIR Resource: Pra…
Location 1
https://hl7.org/fhir/R4/location.html
GET
/fhir/r4/Location/{id}
Fetches Location by id. Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated. FHIR Resourc…
Organization 1
https://hl7.org/fhir/R4/organization.html
GET
/fhir/r4/Organization/{id}
Fetches an Organization by id. Organization is a formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. FHIR Resourc…
Provenance 1
https://hl7.org/fhir/R4/provenance.html
GET
/fhir/r4/Provenance/{id}
Fetches Provenance by id. Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. FHIR Resource: Proven…
Specimen 2
https://hl7.org/fhir/R4/specimen.html
GET
/fhir/r4/Specimen/{id}
Fetches a single Specimen by ID. FHIR Resource: [Specimen](http://hl7.org/fhir/R4/specimen.html) Retrieves a specific Specimen resource by its logical ID.
GET
/fhir/r4/Specimen
Fetches a Bundle containing Specimen resources. Supports filtering by patient or id. If neither parameter is provided, the server will return a 400 Bad Request. FHIR Resource: [Specimen](http://hl7.o…
RelatedPerson 2
https://hl7.org/fhir/R4/relatedperson.html
GET
/fhir/r4/RelatedPerson/{id}
Fetches a Related Person by id. FHIR Resource: RelatedPerson Related Person
GET
/fhir/r4/RelatedPerson
Fetches a bundled resource containing RelatedPerson data based on the provided parameters. - If patientid is provided, a bundle containing a related persons is returned. FHIR Resource: Related Person…
Coverage 2
https://hl7.org/fhir/R4/coverage.html
GET
/fhir/r4/Coverage/{id}
Fetches a Coverage by id. FHIR Resource: Coverage Coverage resource represents insurance coverage details for a patient
GET
/fhir/r4/Coverage
Fetches a bundled resource containing Coverage data based on the provided parameters. - If patient is provided, a bundle containing the coverages is returned. FHIR Resource: Coverage Coverage resourc…
CCDA 1
GET
/ccda
Fetches a resource containing details of the Patient in CCDA format
Schemas 44
The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are MedicationRequest (15 properties), Device (14 properties), Encounter (13 properties), Patient (12 properties). Each schema is shown below with its type and property counts.
Condition
object
10 properties
9 required
ConditionBundled
object
7 properties
7 required
Practitioner
object
7 properties
7 required
PractitionerRole
object
9 properties
4 required
PractitionerRoleBundled
object
7 properties
7 required
RelatedPerson
object
9 properties
5 required
RelatedPersonBundled
object
7 properties
5 required
Coverage
object
12 properties
5 required
CoverageBundled
object
7 properties
5 required
Device
object
14 properties
2 required
PatientBundled
object
6 properties
6 required
Patient
object
12 properties
10 required
DocumentReference
object
A reference to a document
12 properties
DocumentReferenceBundled
object
7 properties
Observation
object
12 properties
11 required
Goal
object
7 properties
7 required
GoalBundled
object
7 properties
7 required
ObservationBundled
object
7 properties
7 required
Procedure
object
7 properties
5 required
ProcedureBundled
object
7 properties
7 required
DeviceBundled
object
7 properties
7 required
Encounter
object
13 properties
7 required
EncounterBundled
object
7 properties
4 required
Organization
object
A grouping of people or organizations with a common purpose
8 properties
10 required
Immunization
object
9 properties
5 required
ImmunizationBundled
object
7 properties
6 required
Location
object
Details and position information for a physical place
9 properties
9 required
AllergyIntolerance
object
9 properties
5 required
AllergyIntoleranceBundled
object
7 properties
5 required
CareTeam
object
5 properties
1 required
CareTeamBundled
object
7 properties
5 required
Provenance
object
6 properties
14 required
CarePlan
object
9 properties
6 required
CarePlanBundled
object
7 properties
5 required
DiagnosticReportBundled
object
7 properties
7 required
DiagnosticReport
object
12 properties
12 required
MedicationRequest
object
15 properties
15 required
MedicationRequestBundled
object
7 properties
7 required
Specimen
object
6 properties
2 required
SpecimenBundled
object
A FHIR Bundle of Specimen resources
4 properties
MedicationDispense
object
Dispensing a medication to a named patient
11 properties
11 required
MedicationDispenseBundled
object
A FHIR Bundle of MedicationDispense resources
7 properties
3 required
MedicationAdministration
object
Administration of medication to a patient
11 properties
6 required
MedicationAdministrationBundled
object
A FHIR Bundle of MedicationAdministration resources
7 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from NextGen Healthcare 4
Other APIs NextGen Healthcare publishes across the network.
NextGen Enterprise Patient Access FHIR API
NextGen Enterprise API
NextGen Office Bulk FHIR R4 API
NextGen Office FHIR R3 API
#FHIR#Patient Access#EHR#SMART on FHIR