{"id":27445,"date":"2025-02-28T09:06:01","date_gmt":"2025-02-28T14:06:01","guid":{"rendered":"https:\/\/www.medicalofficeforce.com\/?page_id=27445"},"modified":"2025-03-19T06:07:01","modified_gmt":"2025-03-19T10:07:01","slug":"developer-api","status":"publish","type":"page","link":"https:\/\/www.medicalofficeforce.com\/es\/developer-api\/","title":{"rendered":"Developer API"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-page\" data-elementor-id=\"27445\" class=\"elementor elementor-27445\">\n\t\t\t\t<div class=\"elementor-element elementor-element-8c13463 e-flex e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"8c13463\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-1242948 elementor-widget elementor-widget-html\" data-id=\"1242948\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"html.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<style>\n    body{\n        background:#fff !important;\n    }\n<\/style>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-bfb72ec e-flex e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"bfb72ec\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-dbfe6a3 elementor-widget elementor-widget-heading\" data-id=\"dbfe6a3\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\">Developer API<\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-c23b4e0 e-flex e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"c23b4e0\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-e743b94 elementor-widget elementor-widget-text-editor\" data-id=\"e743b94\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The\u00a0<span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">Medical Office Force FHIR API<\/span>\u00a0allows you to connect to Medical Office Force products using the\u00a0<span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">FHIR (Fast Healthcare Interoperability Resources)<\/span>\u00a0standard for healthcare resources.<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The FHIR standard enables application developers to create products and exchange clinical data in a secure manner that is consistent, flexible, and easy to implement.<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The FHIR standard is constantly evolving. This version of the Medical Office Force FHIR API supports\u00a0<span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">FHIR release 4 (\u201cR4\u201d)<\/span>\u00a0and the\u00a0<span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">United States Core Data for Interoperability (\u201cUS Core\u201d)<\/span>\u00a0guidelines and requirements for data sharing.<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">Previous versions of the Medical Office Force FHIR API were compatible with the\u00a0<span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">DSTU2<\/span>\u00a0release. That version is still available, and the documentation is available separately.<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">A note on terminology: For the purpose of this documentation, the term \u201capplication\u201d refers to a software program connecting to a Medical Office Force product through the Medical Office Force FHIR API. The term \u201cproduct\u201d refers to the Medical Office Force EHR.<\/p><div>\u00a0<\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-063d403 elementor-widget elementor-widget-heading\" data-id=\"063d403\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\"><h1 style=\"font-size: 24px;font-family: Arial, sans-serif;letter-spacing: -0.1px;text-transform: none\">Capability Statement<span style=\"font-family: Roboto, sans-serif;font-size: 26px;font-weight: 600;text-transform: uppercase\"><\/span><\/h1><\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-06a0e42 elementor-widget elementor-widget-text-editor\" data-id=\"06a0e42\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">A FHIR Capability Statement documents the set of capabilities and behaviours available from the FHIR API service implementation. The Capability Statement includes information about supported FHIR resources and security protocols and should be used by applications as the set of rules the application should follow.<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">To get a copy of the Medical Office Force FHIR API capability statement, make the following request:<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">GET\/FHIR path]\/metadata<\/p>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-cb6c5a6 elementor-widget elementor-widget-heading\" data-id=\"cb6c5a6\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\"><h1 style=\"font-size: 24px;font-family: Arial, sans-serif;letter-spacing: -0.1px;text-transform: none\">FHIR Resources<span style=\"font-family: Roboto, sans-serif;font-size: 26px;font-weight: 600;text-transform: uppercase;white-space: pre-wrap;text-align: var(--text-align);float: none\"><\/span><\/h1><\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-cc1b8bb elementor-widget elementor-widget-text-editor\" data-id=\"cc1b8bb\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<ul><li style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The Medical Office Force FHIR API allows users to search for and access selected clinical, demographic, and facility information via REST. This data is referred to by FHIR as resources and include healthcare or related items such as patients or medications. All resources are addressable by a unique identifier (id) that can be used to access or reference them.<\/li><\/ul><div><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">FHIR resources are accessed through HTTP and use the HTTP verbs. For example:<\/p><ul><li><span style=\"color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; font-weight: bold; text-align: var(--text-align); text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\">GET:<\/span><span style=\"font-family: Poppins; color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; text-align: var(--text-align);\">\u00a0Retrieve and search for FHIR resources.<\/span><br \/><span style=\"color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; font-weight: bold; text-align: var(--text-align); text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\">POST:<\/span><span style=\"font-family: Poppins; color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; text-align: var(--text-align);\">\u00a0Save a new FHIR resource. Do not send an _ID value for the new resource with a POST request. Passing an _ID value indicates to the Medical Office Force FHIR API that the resource already exists and results in an error.\u00a0<\/span><span style=\"color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; font-weight: bold; text-align: var(--text-align); text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\">Note:<\/span><span style=\"font-family: Poppins; color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; text-align: var(--text-align);\">\u00a0The May 2022 version of the Medical Office Force FHIR API does not support writing data back to the product.<\/span><br \/><span style=\"color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; font-weight: bold; text-align: var(--text-align); text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\">PUT:<\/span><span style=\"font-family: Poppins; color: rgba(0, 0, 0, 0.87); font-size: 14px; letter-spacing: -0.1px; text-align: var(--text-align);\">\u00a0Update a FHIR resource. A PUT request must include the _ID value for the resource. The PUT request also requires an If-Match value in the HTTP header. This is used to validate that the version of the resource in the application that is being updated matches the version in the product database. This prevents conflicting updates.<\/span><\/li><li><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The Medical Office Force FHIR API supports both JSON and XML formats. By default, the Medical Office Force FHIR API returns data in JSON. Use the Accept HTTP header to control this format.<\/p><div><ul style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: rgba(0, 0, 0, 0.87); font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\"><li style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\"><span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">*\/*:<\/span>\u00a0Application accepts anything.<\/li><li style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\"><span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">application\/fhir+XML:<\/span>\u00a0Response is in XML.<\/li><li style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent;\"><span style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; font-weight: bold;\">application\/fhir+JSON:<\/span>\u00a0Response is in JSON.<\/li><\/ul><\/div><\/li><\/ul><\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-cab9419 elementor-widget elementor-widget-heading\" data-id=\"cab9419\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\"><h1 style=\"font-size: 24px;font-family: Arial, sans-serif;letter-spacing: -0.1px;text-transform: none\">Authorization<span style=\"font-family: Roboto, sans-serif;font-size: 26px;font-weight: 600;text-transform: uppercase;text-align: var(--text-align)\"><\/span><\/h1><\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-3f5fff0 elementor-widget elementor-widget-text-editor\" data-id=\"3f5fff0\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The Medical Office Force FHIR API supports the HL7\u00ae SMART Application Launch Framework Implementation Guide Release 1.0.0 implementation specification, a profile of the OAuth 2.0 specification. Additionally, the Medical Office Force FHIR API supports OpenID Connect Core 1.0. For more information on these specifications, see hl7.org\/fhir\/smart-app-launch\/1.0.0\/.<\/p><p style=\"text-rendering: optimizelegibility; -webkit-tap-highlight-color: transparent; color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The following sections describe the authorization flows for FHIR applications.<\/p><div>\u00a0<\/div>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-fbcd457 elementor-widget elementor-widget-heading\" data-id=\"fbcd457\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\"><h1 style=\"font-size: 24px;font-family: Arial, sans-serif;letter-spacing: -0.1px;text-transform: none\">Stand-alone application launch for a Medical Office Force product user<span style=\"font-family: Roboto, sans-serif;font-weight: 600;text-align: var(--text-align);font-size: 26px;text-transform: uppercase\"><\/span><\/h1><\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-74d2dcd elementor-widget elementor-widget-text-editor\" data-id=\"74d2dcd\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<p><span style=\"color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory. Typically, endpoints that include \/fhir are for product users. These (non-patient) application endpoints can also be tagged with a Provider badge on the Endpoint Directory.<\/span><\/p><ol><li style=\"list-style-type: none;\"><ol><li>The application requests the Capability Statement from the Medical Office Force FHIR server.<\/li><li>The Medical Office Force FHIR server returns the Capability Statement, which includes two endpoints:<ul><li><strong>Authorize endpoint:<\/strong>\u00a0for the Medical Office Force Authorization server<\/li><li><strong>Token endpoint<\/strong><\/li><\/ul><p>For example:<\/p><code><\/code><pre>[\n  {\n    \"url\": \"authorize\",\n    \"valueUri\": \"https:\/\/...\/authorize\"\n  },\n  {\n    \"url\": \"token\",\n    \"valueUri\": \"https:\/\/...\/token\"\n  }\n]<\/pre><\/li><li>The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret (available on the FHIR App page on the Medical Office Force Connect Portal).<\/li><li>If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application in the Medical Office Force License Management Portal), the product&#8217;s login screen displays. The user can enter their user credentials (user ID and password) in the product.<\/li><\/ol><\/li><\/ol><p>If the application credentials are not recognized by the Medical Office Force Authorization server, the server returns an error.<\/p><ol><li>OAuth sends the user&#8217;s product credentials to the Medical Office Force Authorization server. If the credentials are valid, the server returns a temporary token to the application&#8217;s Callback URL (as defined in the Medical Office Force Connect Portal for the application).<\/li><li>The application then sends the temporary token to the token endpoint, and the Medical Office Force Authorization server returns a regular token. The length of time during which the token is valid is defined in the Medical Office Force License Management Portal.<\/li><\/ol>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-97b71ef elementor-widget elementor-widget-heading\" data-id=\"97b71ef\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"heading.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t<h2 class=\"elementor-heading-title elementor-size-default\"><h1 style=\"font-size: 24px;font-family: Arial, sans-serif;letter-spacing: -0.1px;text-transform: none\">Stand-alone application launch for a patient<span style=\"font-family: Roboto, sans-serif;font-weight: 600;text-align: var(--text-align);font-size: 26px;text-transform: uppercase;white-space: pre-wrap;float: none\"><\/span><\/h1><\/h2>\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<div class=\"elementor-element elementor-element-ec0cd46 elementor-widget elementor-widget-text-editor\" data-id=\"ec0cd46\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"text-editor.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<p><span style=\"color: #333333; font-family: Arial, sans-serif; font-size: 14px; letter-spacing: -0.1px;\">The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory Endpoint Directory. Typically, endpoints that include \/open are for patient applications. These patient application endpoints can also be tagged with a Patient badge on the Endpoint Directory.<\/span><\/p><ol><li>The application requests the Capability Statement from Medical Office Force FHIR server.<\/li><li>The Medical Office Force FHIR server returns the Capability Statement which includes the authorize endpoint for the Medical Office Force Authorization server and the token endpoint.<\/li><li>The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret. (On the FHIR App page on the Medical Office Force Connect Portal.)<\/li><li>If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application), the server verifies that the patient is valid.<\/li><\/ol><ol>\n<\/ol>\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-344ad35 e-flex e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"344ad35\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-5a708b1 e-flex e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"5a708b1\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-12cf547 elementor-widget elementor-widget-button\" data-id=\"12cf547\" data-element_type=\"widget\" data-e-type=\"widget\" data-widget_type=\"button.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t\t\t\t\t\t\t<div class=\"elementor-button-wrapper\">\n\t\t\t\t\t<a class=\"elementor-button elementor-button-link elementor-size-sm\" href=\"https:\/\/documenter.getpostman.com\/view\/3011282\/2sAYdfqWLp\" target=\"_blank\">\n\t\t\t\t\t\t<span class=\"elementor-button-content-wrapper\">\n\t\t\t\t\t\t\t\t\t<span class=\"elementor-button-text\">Api Documentation<\/span>\n\t\t\t\t\t<\/span>\n\t\t\t\t\t<\/a>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-63edf7e e-con-full e-flex wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-child\" data-id=\"63edf7e\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-7f60e72 e-flex e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"7f60e72\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t<div class=\"elementor-element elementor-element-5b4ee4a e-grid e-con-boxed wpr-particle-no wpr-jarallax-no wpr-parallax-no wpr-sticky-section-no wpr-equal-height-no e-con e-parent\" data-id=\"5b4ee4a\" data-element_type=\"container\" data-e-type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>Developer API The\u00a0Medical Office Force FHIR API\u00a0allows you to connect to Medical Office Force products using the\u00a0FHIR (Fast Healthcare Interoperability Resources)\u00a0standard for healthcare resources. The FHIR standard enables application developers to create products and exchange clinical data in a secure manner that is consistent, flexible, and easy to implement. The FHIR standard is constantly evolving. This version of the Medical Office Force FHIR API supports\u00a0FHIR release 4 (\u201cR4\u201d)\u00a0and the\u00a0United States Core Data for Interoperability (\u201cUS Core\u201d)\u00a0guidelines and requirements for data sharing. Previous versions of the Medical Office Force FHIR API were compatible with the\u00a0DSTU2\u00a0release. That version is still available, and the documentation is available separately. A note on terminology: For the purpose of this documentation, the term \u201capplication\u201d refers to a software program connecting to a Medical Office Force product through the Medical Office Force FHIR API. The term \u201cproduct\u201d refers to the Medical Office Force EHR. \u00a0 Capability Statement A FHIR Capability Statement documents the set of capabilities and behaviours available from the FHIR API service implementation. The Capability Statement includes information about supported FHIR resources and security protocols and should be used by applications as the set of rules the application should follow. To get a copy of the Medical Office Force FHIR API capability statement, make the following request: GET\/FHIR path]\/metadata FHIR Resources The Medical Office Force FHIR API allows users to search for and access selected clinical, demographic, and facility information via REST. This data is referred to by FHIR as resources and include healthcare or related items such as patients or medications. All resources are addressable by a unique identifier (id) that can be used to access or reference them. FHIR resources are accessed through HTTP and use the HTTP verbs. For example: GET:\u00a0Retrieve and search for FHIR resources.POST:\u00a0Save a new FHIR resource. Do not send an _ID value for the new resource with a POST request. Passing an _ID value indicates to the Medical Office Force FHIR API that the resource already exists and results in an error.\u00a0Note:\u00a0The May 2022 version of the Medical Office Force FHIR API does not support writing data back to the product.PUT:\u00a0Update a FHIR resource. A PUT request must include the _ID value for the resource. The PUT request also requires an If-Match value in the HTTP header. This is used to validate that the version of the resource in the application that is being updated matches the version in the product database. This prevents conflicting updates. The Medical Office Force FHIR API supports both JSON and XML formats. By default, the Medical Office Force FHIR API returns data in JSON. Use the Accept HTTP header to control this format. *\/*:\u00a0Application accepts anything. application\/fhir+XML:\u00a0Response is in XML. application\/fhir+JSON:\u00a0Response is in JSON. Authorization The Medical Office Force FHIR API supports the HL7\u00ae SMART Application Launch Framework Implementation Guide Release 1.0.0 implementation specification, a profile of the OAuth 2.0 specification. Additionally, the Medical Office Force FHIR API supports OpenID Connect Core 1.0. For more information on these specifications, see hl7.org\/fhir\/smart-app-launch\/1.0.0\/. The following sections describe the authorization flows for FHIR applications. \u00a0 Stand-alone application launch for a Medical Office Force product user The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory. Typically, endpoints that include \/fhir are for product users. These (non-patient) application endpoints can also be tagged with a Provider badge on the Endpoint Directory. The application requests the Capability Statement from the Medical Office Force FHIR server. The Medical Office Force FHIR server returns the Capability Statement, which includes two endpoints: Authorize endpoint:\u00a0for the Medical Office Force Authorization server Token endpoint For example: [ { &#8220;url&#8221;: &#8220;authorize&#8221;, &#8220;valueUri&#8221;: &#8220;https:\/\/&#8230;\/authorize&#8221; }, { &#8220;url&#8221;: &#8220;token&#8221;, &#8220;valueUri&#8221;: &#8220;https:\/\/&#8230;\/token&#8221; } ] The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret (available on the FHIR App page on the Medical Office Force Connect Portal). If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application in the Medical Office Force License Management Portal), the product&#8217;s login screen displays. The user can enter their user credentials (user ID and password) in the product. If the application credentials are not recognized by the Medical Office Force Authorization server, the server returns an error. OAuth sends the user&#8217;s product credentials to the Medical Office Force Authorization server. If the credentials are valid, the server returns a temporary token to the application&#8217;s Callback URL (as defined in the Medical Office Force Connect Portal for the application). The application then sends the temporary token to the token endpoint, and the Medical Office Force Authorization server returns a regular token. The length of time during which the token is valid is defined in the Medical Office Force License Management Portal. Stand-alone application launch for a patient The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory Endpoint Directory. Typically, endpoints that include \/open are for patient applications. These patient application endpoints can also be tagged with a Patient badge on the Endpoint Directory. The application requests the Capability Statement from Medical Office Force FHIR server. The Medical Office Force FHIR server returns the Capability Statement which includes the authorize endpoint for the Medical Office Force Authorization server and the token endpoint. The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret. (On the FHIR App page on the Medical Office Force Connect Portal.) If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application), the server verifies that the patient is valid. Api Documentation<\/p>\n","protected":false},"author":221724646,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"elementor_header_footer","meta":{"footnotes":""},"class_list":["post-27445","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Developer API - Medical Office Force<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.medicalofficeforce.com\/es\/developer-api\/\" \/>\n<meta property=\"og:locale\" content=\"es_MX\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Developer API - Medical Office Force\" \/>\n<meta property=\"og:description\" content=\"Developer API The\u00a0Medical Office Force FHIR API\u00a0allows you to connect to Medical Office Force products using the\u00a0FHIR (Fast Healthcare Interoperability Resources)\u00a0standard for healthcare resources. The FHIR standard enables application developers to create products and exchange clinical data in a secure manner that is consistent, flexible, and easy to implement. The FHIR standard is constantly evolving. This version of the Medical Office Force FHIR API supports\u00a0FHIR release 4 (\u201cR4\u201d)\u00a0and the\u00a0United States Core Data for Interoperability (\u201cUS Core\u201d)\u00a0guidelines and requirements for data sharing. Previous versions of the Medical Office Force FHIR API were compatible with the\u00a0DSTU2\u00a0release. That version is still available, and the documentation is available separately. A note on terminology: For the purpose of this documentation, the term \u201capplication\u201d refers to a software program connecting to a Medical Office Force product through the Medical Office Force FHIR API. The term \u201cproduct\u201d refers to the Medical Office Force EHR. \u00a0 Capability Statement A FHIR Capability Statement documents the set of capabilities and behaviours available from the FHIR API service implementation. The Capability Statement includes information about supported FHIR resources and security protocols and should be used by applications as the set of rules the application should follow. To get a copy of the Medical Office Force FHIR API capability statement, make the following request: GET\/FHIR path]\/metadata FHIR Resources The Medical Office Force FHIR API allows users to search for and access selected clinical, demographic, and facility information via REST. This data is referred to by FHIR as resources and include healthcare or related items such as patients or medications. All resources are addressable by a unique identifier (id) that can be used to access or reference them. FHIR resources are accessed through HTTP and use the HTTP verbs. For example: GET:\u00a0Retrieve and search for FHIR resources.POST:\u00a0Save a new FHIR resource. Do not send an _ID value for the new resource with a POST request. Passing an _ID value indicates to the Medical Office Force FHIR API that the resource already exists and results in an error.\u00a0Note:\u00a0The May 2022 version of the Medical Office Force FHIR API does not support writing data back to the product.PUT:\u00a0Update a FHIR resource. A PUT request must include the _ID value for the resource. The PUT request also requires an If-Match value in the HTTP header. This is used to validate that the version of the resource in the application that is being updated matches the version in the product database. This prevents conflicting updates. The Medical Office Force FHIR API supports both JSON and XML formats. By default, the Medical Office Force FHIR API returns data in JSON. Use the Accept HTTP header to control this format. *\/*:\u00a0Application accepts anything. application\/fhir+XML:\u00a0Response is in XML. application\/fhir+JSON:\u00a0Response is in JSON. Authorization The Medical Office Force FHIR API supports the HL7\u00ae SMART Application Launch Framework Implementation Guide Release 1.0.0 implementation specification, a profile of the OAuth 2.0 specification. Additionally, the Medical Office Force FHIR API supports OpenID Connect Core 1.0. For more information on these specifications, see hl7.org\/fhir\/smart-app-launch\/1.0.0\/. The following sections describe the authorization flows for FHIR applications. \u00a0 Stand-alone application launch for a Medical Office Force product user The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory. Typically, endpoints that include \/fhir are for product users. These (non-patient) application endpoints can also be tagged with a Provider badge on the Endpoint Directory. The application requests the Capability Statement from the Medical Office Force FHIR server. The Medical Office Force FHIR server returns the Capability Statement, which includes two endpoints: Authorize endpoint:\u00a0for the Medical Office Force Authorization server Token endpoint For example: [ { &quot;url&quot;: &quot;authorize&quot;, &quot;valueUri&quot;: &quot;https:\/\/...\/authorize&quot; }, { &quot;url&quot;: &quot;token&quot;, &quot;valueUri&quot;: &quot;https:\/\/...\/token&quot; } ] The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret (available on the FHIR App page on the Medical Office Force Connect Portal). If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application in the Medical Office Force License Management Portal), the product&#8217;s login screen displays. The user can enter their user credentials (user ID and password) in the product. If the application credentials are not recognized by the Medical Office Force Authorization server, the server returns an error. OAuth sends the user&#8217;s product credentials to the Medical Office Force Authorization server. If the credentials are valid, the server returns a temporary token to the application&#8217;s Callback URL (as defined in the Medical Office Force Connect Portal for the application). The application then sends the temporary token to the token endpoint, and the Medical Office Force Authorization server returns a regular token. The length of time during which the token is valid is defined in the Medical Office Force License Management Portal. Stand-alone application launch for a patient The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory Endpoint Directory. Typically, endpoints that include \/open are for patient applications. These patient application endpoints can also be tagged with a Patient badge on the Endpoint Directory. The application requests the Capability Statement from Medical Office Force FHIR server. The Medical Office Force FHIR server returns the Capability Statement which includes the authorize endpoint for the Medical Office Force Authorization server and the token endpoint. The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret. (On the FHIR App page on the Medical Office Force Connect Portal.) If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application), the server verifies that the patient is valid. Api Documentation\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.medicalofficeforce.com\/es\/developer-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Medical Office Force\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-19T10:07:01+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Tiempo de lectura\" \/>\n\t<meta name=\"twitter:data1\" content=\"5 minutos\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/developer-api\\\/\",\"url\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/developer-api\\\/\",\"name\":\"Developer API - Medical Office Force\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/#website\"},\"datePublished\":\"2025-02-28T14:06:01+00:00\",\"dateModified\":\"2025-03-19T10:07:01+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/developer-api\\\/#breadcrumb\"},\"inLanguage\":\"es\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.medicalofficeforce.com\\\/developer-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/developer-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Developer API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/#website\",\"url\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/\",\"name\":\"Medical Office Force\",\"description\":\"Optimizing Healthcare Finance\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.medicalofficeforce.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"es\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Developer API - Medical Office Force","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.medicalofficeforce.com\/es\/developer-api\/","og_locale":"es_MX","og_type":"article","og_title":"Developer API - Medical Office Force","og_description":"Developer API The\u00a0Medical Office Force FHIR API\u00a0allows you to connect to Medical Office Force products using the\u00a0FHIR (Fast Healthcare Interoperability Resources)\u00a0standard for healthcare resources. The FHIR standard enables application developers to create products and exchange clinical data in a secure manner that is consistent, flexible, and easy to implement. The FHIR standard is constantly evolving. This version of the Medical Office Force FHIR API supports\u00a0FHIR release 4 (\u201cR4\u201d)\u00a0and the\u00a0United States Core Data for Interoperability (\u201cUS Core\u201d)\u00a0guidelines and requirements for data sharing. Previous versions of the Medical Office Force FHIR API were compatible with the\u00a0DSTU2\u00a0release. That version is still available, and the documentation is available separately. A note on terminology: For the purpose of this documentation, the term \u201capplication\u201d refers to a software program connecting to a Medical Office Force product through the Medical Office Force FHIR API. The term \u201cproduct\u201d refers to the Medical Office Force EHR. \u00a0 Capability Statement A FHIR Capability Statement documents the set of capabilities and behaviours available from the FHIR API service implementation. The Capability Statement includes information about supported FHIR resources and security protocols and should be used by applications as the set of rules the application should follow. To get a copy of the Medical Office Force FHIR API capability statement, make the following request: GET\/FHIR path]\/metadata FHIR Resources The Medical Office Force FHIR API allows users to search for and access selected clinical, demographic, and facility information via REST. This data is referred to by FHIR as resources and include healthcare or related items such as patients or medications. All resources are addressable by a unique identifier (id) that can be used to access or reference them. FHIR resources are accessed through HTTP and use the HTTP verbs. For example: GET:\u00a0Retrieve and search for FHIR resources.POST:\u00a0Save a new FHIR resource. Do not send an _ID value for the new resource with a POST request. Passing an _ID value indicates to the Medical Office Force FHIR API that the resource already exists and results in an error.\u00a0Note:\u00a0The May 2022 version of the Medical Office Force FHIR API does not support writing data back to the product.PUT:\u00a0Update a FHIR resource. A PUT request must include the _ID value for the resource. The PUT request also requires an If-Match value in the HTTP header. This is used to validate that the version of the resource in the application that is being updated matches the version in the product database. This prevents conflicting updates. The Medical Office Force FHIR API supports both JSON and XML formats. By default, the Medical Office Force FHIR API returns data in JSON. Use the Accept HTTP header to control this format. *\/*:\u00a0Application accepts anything. application\/fhir+XML:\u00a0Response is in XML. application\/fhir+JSON:\u00a0Response is in JSON. Authorization The Medical Office Force FHIR API supports the HL7\u00ae SMART Application Launch Framework Implementation Guide Release 1.0.0 implementation specification, a profile of the OAuth 2.0 specification. Additionally, the Medical Office Force FHIR API supports OpenID Connect Core 1.0. For more information on these specifications, see hl7.org\/fhir\/smart-app-launch\/1.0.0\/. The following sections describe the authorization flows for FHIR applications. \u00a0 Stand-alone application launch for a Medical Office Force product user The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory. Typically, endpoints that include \/fhir are for product users. These (non-patient) application endpoints can also be tagged with a Provider badge on the Endpoint Directory. The application requests the Capability Statement from the Medical Office Force FHIR server. The Medical Office Force FHIR server returns the Capability Statement, which includes two endpoints: Authorize endpoint:\u00a0for the Medical Office Force Authorization server Token endpoint For example: [ { \"url\": \"authorize\", \"valueUri\": \"https:\/\/...\/authorize\" }, { \"url\": \"token\", \"valueUri\": \"https:\/\/...\/token\" } ] The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret (available on the FHIR App page on the Medical Office Force Connect Portal). If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application in the Medical Office Force License Management Portal), the product&#8217;s login screen displays. The user can enter their user credentials (user ID and password) in the product. If the application credentials are not recognized by the Medical Office Force Authorization server, the server returns an error. OAuth sends the user&#8217;s product credentials to the Medical Office Force Authorization server. If the credentials are valid, the server returns a temporary token to the application&#8217;s Callback URL (as defined in the Medical Office Force Connect Portal for the application). The application then sends the temporary token to the token endpoint, and the Medical Office Force Authorization server returns a regular token. The length of time during which the token is valid is defined in the Medical Office Force License Management Portal. Stand-alone application launch for a patient The endpoint for the product&#8217;s Medical Office Force FHIR server is available from the Medical Office Force Endpoint Directory Endpoint Directory. Typically, endpoints that include \/open are for patient applications. These patient application endpoints can also be tagged with a Patient badge on the Endpoint Directory. The application requests the Capability Statement from Medical Office Force FHIR server. The Medical Office Force FHIR server returns the Capability Statement which includes the authorize endpoint for the Medical Office Force Authorization server and the token endpoint. The application sends credentials to the Medical Office Force Authorization server. These credentials include the application&#8217;s client ID and client secret. (On the FHIR App page on the Medical Office Force Connect Portal.) If the application credentials are recognized by the Medical Office Force Authorization server (meaning the client has authorized the application), the server verifies that the patient is valid. Api Documentation","og_url":"https:\/\/www.medicalofficeforce.com\/es\/developer-api\/","og_site_name":"Medical Office Force","article_modified_time":"2025-03-19T10:07:01+00:00","twitter_card":"summary_large_image","twitter_misc":{"Tiempo de lectura":"5 minutos"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.medicalofficeforce.com\/developer-api\/","url":"https:\/\/www.medicalofficeforce.com\/developer-api\/","name":"Developer API - Medical Office Force","isPartOf":{"@id":"https:\/\/www.medicalofficeforce.com\/#website"},"datePublished":"2025-02-28T14:06:01+00:00","dateModified":"2025-03-19T10:07:01+00:00","breadcrumb":{"@id":"https:\/\/www.medicalofficeforce.com\/developer-api\/#breadcrumb"},"inLanguage":"es","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.medicalofficeforce.com\/developer-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.medicalofficeforce.com\/developer-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.medicalofficeforce.com\/"},{"@type":"ListItem","position":2,"name":"Developer API"}]},{"@type":"WebSite","@id":"https:\/\/www.medicalofficeforce.com\/#website","url":"https:\/\/www.medicalofficeforce.com\/","name":"Medical Office Force","description":"Optimizing Healthcare Finance","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.medicalofficeforce.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"es"}]}},"_links":{"self":[{"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/pages\/27445","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/users\/221724646"}],"replies":[{"embeddable":true,"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/comments?post=27445"}],"version-history":[{"count":0,"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/pages\/27445\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.medicalofficeforce.com\/es\/wp-json\/wp\/v2\/media?parent=27445"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}