Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• R4 Overview
  • Service Root URL
  • Proprietary Codes and Systems

Tasks

• Account
  • Get a list of accounts
  • Get an account by ID
• AllergyIntolerance
  • Create an allergy intolerance
  • Get a list of allergy intolerances
  • Get an allergy intolerance by ID
  • Update an allergy intolerance
• Appointment
  • Create an appointment
  • Get a list of appointments
  • Get an appointment by ID
  • Patch an appointment
• Binary
  • Get a binary CCD
  • Get a binary document by ID
• Bundle
  • Run a FHIR batch (or FHIR transaction) bundle
• CapabilityStatement
  • Get metadata
  • Get well-known SMART configuration
• CarePlan
  • Get a care plan by ID
  • Get a list of care plans
• CareTeam
  • Get a care team by ID
  • Get a list of care teams
• ChargeItem
  • Create a charge item
  • Create a credit charge item
  • Create a modified charge item
  • Get a charge item by ID
  • Get a list of charge items
• Communication
  • Create a communication
  • Get a communication by ID
  • Get a list of communications
  • Update a communication
• Condition
  • Create a condition
  • Get a condition by ID
  • Get a list of conditions
  • Update a condition
• Consent
  • Get a consent by ID
  • Get a list of consents
• Coverage
  • Create a coverage
  • Delete a coverage
  • Get a coverage by ID
  • Get a list of coverages
  • Patch a coverage
• Device
  • Get a device by ID
  • Get a list of devices
• DiagnosticReport
  • Create a diagnostic report
  • Get a diagnostic report by ID
  • Get a list of diagnostic reports
• DocumentReference
  • Create a document reference
  • Get a document reference by ID
  • Get a list of document references
  • Get a list of document references with $docref
  • Update a document reference
• Encounter
  • Create an encounter
  • Get a list of encounters
  • Get an encounter by ID
  • Patch an encounter by ID
• FamilyMemberHistory
  • Create a family member history
  • Get a family member history by ID
  • Get a list of family member histories
  • Update a family member history
• FinancialTransaction
  • Create a financial transaction
• Goal
  • Get a goal by ID
  • Get a list of goals
• Health Cards
  • Issue health cards for an existing patient
• Immunization
  • Create an immunization
  • Get a list of immunizations
  • Get an immunization by ID
  • Update an immunization
• InsurancePlan
  • Get a list of insurance plans
  • Get an insurance plan by ID
• Location
  • Get a list of locations
  • Get a location by ID
• Media
  • Get media by ID
• MedicationAdministration
  • Get a list of medication administrations
  • Get a medication administration by ID
• MedicationDispense
  • Get a list of medication dispenses
  • Get a medication dispense by ID
• MedicationRequest
  • Create a medication request
  • Get a list of medication requests
  • Get a medication request by ID
  • Patch a medication request
• NutritionOrder
  • Get a list of nutrition orders
  • Get a nutrition order by ID
• Observation
  • Create an observation
  • Get a list of observations
  • Get an observation by ID
  • Update an observation
• OperationDefinition
  • Get an operation definition by ID
• Organization
  • Create an organization
  • Get a list of caregiver organizations
  • Get a list of organizations
  • Get an organization by ID
• Patient
  • Create a patient
  • Get a list of patients
  • Get a patient by ID
  • Patch a patient
• Person
  • Get a list of persons
  • Get a person by ID
• Practitioner
  • Create a practitioner
  • Get a list of practitioners
  • Get a practitioner by ID
• Procedure
  • Create a procedure
  • Get a list of procedures
  • Get a procedure by ID
• Provenance
  • Create a provenance
  • Get a list of provenances
  • Get a provenance by ID
• Questionnaire
  • Get a list of questionnaires
  • Get a questionnaire by ID
• QuestionnaireResponse
  • Get a list of questionnaire reponses
  • Get a questionnaire reponse by ID
  • Update a questionnaire response
• RelatedPerson
  • Create a related person record
  • Get a list of related person records
  • Get a related person record by ID
  • Patch a related person record
• Schedule
  • Get a list of schedules
  • Get a schedule by ID
• ServiceRequest
  • Get a list of service requests
  • Get a service request by ID
• Slot
  • Get a list of slots
  • Get a slot by ID
  • Patch a slot
• Specimen
  • Get a list of specimens
  • Get a specimen by ID
• StructureDefinition
  • Get a structure definition by ID