{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c25240ee-3125-4bb6-b61a-2183e1a6040c","name":"EyeMD EMR - FHIR API","description":"EyeMD EMR Health Care Systems Inc. \n27300 Riverview Center Blvd \nSuite 100 \nBonita Springs, FL 34134\n\nToll Free: (877) 2 EYE EMR | (877) 239-3367 \nLocal: (239) 829-5959 \nFax: (239) 949-5959\n\n# Overview\n\nThe EyeMD EMR FHIR API enables connection to customer systems using the FHIR (Fast Healthcare Interoperability Resources) standard for healthcare resources. This standard allows application developers to securely create products and exchange clinical data in a consistent, flexible, and easy-to-implement manner.\n\nThe FHIR API is available for customers using EyeMD EMR version 2.0 or later. It supports FHIR Release 4 (R4) and adheres to the United States Core Data for Interoperability (US Core) v1 guidelines and requirements for data sharing.\n\n# General Information\n\n## SMART on FHIR\n\nThe API meets the requirements of the Standardized API for Patient and Population Services criterion §170.315(g)(10) in the 2015 Edition Cures Update. The API supports both SMART App Launch and SMART Backend Services v2.0.0. For more information, please visit [https://hl7.org/fhir/smart-app-launch/](https://hl7.org/fhir/smart-app-launch/).\n\n### Supported Application Types\n\n1. Patient Apps\n \n2. Practitioner Apps (for Healthcare Providers / Practices)\n \n3. Backend System Apps\n \n\n### FHIR Server Capability Metadata\n\nCapability metadata can be queried by appending \"/metadata\" to the Endpoint Service Base URL.\n\n## Patients\n\nPatients interested in connecting to the API using a SMART on FHIR capable app can do so by logging in to their provider's patient portal, scrolling down to the \"API Access\" section, and clicking the \"Request Access\" button. They will then be prompted to authenticate using a Microsoft Live account. If the patient does not have a Microsoft Live account, they will be prompted to enter a code sent to the email they provide in the authentication form.\n\n## Healthcare Providers / Practices\n\nTo make patient data accessible via the FHIR API, some setup is required. First, your IT team must configure a port forward on your router to the EMR Gateway Server port. After this is done, EyeMD EMR will configure the FHIR API server to communicate with your Gateway server. To initiate this process, please contact Customer Service.\n\n## **Application Vendors**\n\nThird-party application vendors interested in accessing the API must first complete a one-time [Application Registration Request](https://www.eyemdemr.com/fhir-app-registration/). Once the registration request is received, it will be processed within 10 days.\n\nTo register your App:\n\n1. Navigate to [https://www.eyemdemr.com/fhir](https://www.eyemdemr.com/fhir)\n \n2. Review the API Documentation and agree to the Terms and Conditions.\n \n3. Complete the SMART on FHIR Application Registration Request form.\n \n\nOnce your registration request is processed, we will send an email response to the supplied email address within 5 days. If your registration request is approved, your app will be registered and enabled, and you will receive an email that includes your credentials and configuration details. If your registration request is denied, you will receive an email with the stated reason for denial. If your request is denied more than 5 times for any reason, further requests will no longer be processed and will be discarded.\n\nFor more information, see the Application Registration Requirement section below.\n\n# Fees\n\n**Patients:** Patients are not charged any fees to access their data using the FHIR API.\n\n**Practice:** Practices using EyeMD EMR are charged a one-time FHIR setup fee of $300 to recover costs associated with integrating their local EMR instance to the FHIR API server. Ongoing throttled access to the API is included as part of the Patient Portal Subscription.\n\n**Application Vendors:** Application vendors are charged a one-time registration fee of $250 to recover costs associated with identity verification and registration as an approved application vendor. Vendors may request live API support for an additional $2,000.\n\nIn addition to the one-time registration fee, Backend System Applications integrating with the FHIR API are charged a one-time setup fee of $750 per practice instance connection to recover costs associated with: \n• Backend system authorization configuration \n• Practice-level API credential provisioning \n• Security and access validation \n• Integration setup and testing\n\nOnce approved, application vendors receive access under a standard usage tier designed to support routine integration needs for data authorized by any EyeMD EMR provider or patient. The first 300 API requests per endpoint per day are processed in real time. Requests exceeding this level continue to be accepted; however, they may be subject to dynamic rate limiting (adaptive throttling) based on current system load and overall platform utilization.\n\nEyeMD EMR applies usage controls and infrastructure scaling policies solely to maintain platform stability, security, and equitable access across all authorized applications. These controls are not intended to restrict lawful access, exchange, or use of electronic health information as permitted under the ONC Information Blocking regulations (45 CFR Part 171).\n\nVendors requiring guaranteed response times, elevated throughput, or dedicated capacity must provide anticipated usage patterns and estimated daily request volumes for review. Based on projected usage and the infrastructure required to support enhanced service levels, expanded access is available on a quoted basis.\n\nVendors are encouraged to implement the API under standard access terms to evaluate real-world usage prior to requesting expanded capacity.\n\n# Setup Instructions\n\n**Patients:**\n\n1\\. Login in to your EyeMD EMR Patient Web Portal.\n\n2\\. Scroll down to the bottom of the Page and press the button \"Request Access\".\n\n\n\n3\\. You will then see the following message that indicates your are now ready to start using Smart Apps.\n\n\n\n**Practices:**\n\n1\\. First, you must be logged in the EMR as an Administrator or Doctor to the practice.\n\n2\\. At the main patient flow select the menu button.\n\n\n\n3\\. Then select the menu choices as shown below, Options - Integration - Interface Options.\n\n\n\n4\\. Scroll to the bottom of the screen and press the + sign to add an app.\n\n\n\n5\\. Fill in the fields as described below, and select the checkbox for \"Practitioner\" (used for an app that presents the data for all patients) or select the checkbox for \"Patient\" (used for an app that presents data for a specific patient). Then press save.\n\n\n\n6\\. The smart app will now be listed in the screen where you originally added it with the + sign. Press save and then at the main patient flow screen you will see a FHIR icon and you are now done.\n\n\n\n\n\n# FHIR Endpoints\n\nSince each EyeMD EMR customer operates in a partitioned and isolated data environment, a unique service base URL endpoint is assigned to each customer. EyeMD EMR supports various data hosting options, necessitating setup for each customer before their FHIR API access is activated and listed.\n\nIf a customer's endpoint is not listed, please reach out to the practice you wish to connect with and encourage them to contact Customer Service to initiate the FHIR API Configuration Setup process.\n\nBelow is an example list of activated FHIR endpoints. The Endpoint Identifier can be obtained by contacting the practice you intend to connect with. This identifier is located at the bottom right of the main EMR application screen. For a complete list, please refer to the \"Download Endpoints as FHIR Bundle\" feature.\n\n\n\n| **Endpoint Identifier** | **Status** | **Service Base URL** |\n| --- | --- | --- |\n| ADV289115 | active | [https://smartonfhir.myeyecarerecords.com/fhir/ADV289115](https://smartonfhir.myeyecarerecords.com/fhir/ADV289115) |\n| ALT227916 | active | [https://smartonfhir.myeyecarerecords.com/fhir/ALT227916](https://smartonfhir.myeyecarerecords.com/fhir/ALT227916) |\n| CHA227610 | active | [https://smartonfhir.myeyecarerecords.com/fhir/CHA227610](https://smartonfhir.myeyecarerecords.com/fhir/EYE227254) |\n| CHO227259 | active | [https://smartonfhir.myeyecarerecords.com/fhir/CHO227259](https://smartonfhir.myeyecarerecords.com/fhir/EYE227392) |\n| EYE227239 | active | [https://smartonfhir.myeyecarerecords.com/fhir/EYE227239](https://smartonfhir.myeyecarerecords.com/fhir/EYE227904) |\n| EYE227254 | active | [https://smartonfhir.myeyecarerecords.com/fhir/EYE227254](https://smartonfhir.myeyecarerecords.com/fhir/EYE227931) |\n| EYE227309 | active | [https://smartonfhir.myeyecarerecords.com/fhir/EYE227309](https://smartonfhir.myeyecarerecords.com/fhir/EYE289101) |\n| EYE227331 | active | [https://smartonfhir.myeyecarerecords.com/fhir/EYE227331](https://smartonfhir.myeyecarerecords.com/fhir/EYE414105) |\n| EYE227530 | active | [https://smartonfhir.myeyecarerecords.com/fhir/227530](https://smartonfhir.myeyecarerecords.com/fhir/TAD187564) |\n| EYE93613 | active | [https://smartonfhir.myeyecarerecords.com/fhir/EYE93613](https://smartonfhir.myeyecarerecords.com/fhir/ALT227916) |\n| HOU227765 | active | [https://smartonfhir.myeyecarerecords.com/fhir/HOU227765](https://smartonfhir.myeyecarerecords.com/fhir/HOU227765) |\n| HUG289117 | active | [https://smartonfhir.myeyecarerecords.com/fhir/HUG289117](https://smartonfhir.myeyecarerecords.com/fhir/HUG289117) |\n| MEL172432 | active | [https://smartonfhir.myeyecarerecords.com/fhir/MEL172432](https://smartonfhir.myeyecarerecords.com/fhir/MEL172432) |\n| MIA172243 | active | [https://smartonfhir.myeyecarerecords.com/fhir/MIA172243](https://smartonfhir.myeyecarerecords.com/fhir/MIA172243) |\n| NAS227941 | active | [https://smartonfhir.myeyecarerecords.com/fhir/NAS227941](https://smartonfhir.myeyecarerecords.com/fhir/NAS227941) |\n| OCE227581 | active | [https://smartonfhir.myeyecarerecords.com/fhir/OCE227581](https://smartonfhir.myeyecarerecords.com/fhir/OCE227581) |\n| OPH227456 | active | [https://smartonfhir.myeyecarerecords.com/fhir/OPH227456](https://smartonfhir.myeyecarerecords.com/fhir/OPH227456) |\n| PLE172984 | active | [https://smartonfhir.myeyecarerecords.com/fhir/PLE172984](https://smartonfhir.myeyecarerecords.com/fhir/PLE172984) |\n| ROB227951 | active | [https://smartonfhir.myeyecarerecords.com/fhir/ROB227951](https://smartonfhir.myeyecarerecords.com/fhir/ROB227951) |\n| SOM227540 | active | [https://smartonfhir.myeyecarerecords.com/fhir/SOM227540](https://smartonfhir.myeyecarerecords.com/fhir/SOM227540) |\n| TAD187564 | active | [https://smartonfhir.myeyecarerecords.com/fhir/TAD187564](https://smartonfhir.myeyecarerecords.com/fhir/TAD187564) |\n| WAS227347 | active | [https://smartonfhir.myeyecarerecords.com/fhir/WAS227347](https://smartonfhir.myeyecarerecords.com/fhir/WAS227347) |\n| WIN227241 | active | [https://smartonfhir.myeyecarerecords.com/fhir/WIN227241](https://smartonfhir.myeyecarerecords.com/fhir/WIN227241) |\n\n[Download Endpoints as FHIR Bundle](https://smartonfhir.myeyecarerecords.com/fhir/Endpoint?_format=application/fhir+json&status=active&_count=1000)\n\n## Authentication Endpoints\n\n| **Description** | **URL** |\n| --- | --- |\n| Authorization Endpoint | [https://smartonfhir.myeyecarerecords.com/oauth2/authorize](https://smartonfhir.myeyecarerecords.com/oauth2/authorize) |\n| Token Endpoint | [https://smartonfhir.myeyecarerecords.com/oauth2/token](https://smartonfhir.myeyecarerecords.com/oauth2/token) |\n| Token Introspection | [https://smartonfhir.myeyecarerecords.com/oauth2/introspect](https://smartonfhir.myeyecarerecords.com/oauth2/introspect) |\n| Token Revocation | [https://smartonfhir.myeyecarerecords.com/oauth2/revoke](https://smartonfhir.myeyecarerecords.com/oauth2/revoke) |\n\n# Authorization\n\nThe EyeMD EMR FHIR API supports the HL7® SMART Application Launch Framework Implementation Guide Release 2.0.0 implementation specification, a profile of the OAuth 2.0 specification. Additionally, the FHIR API supports OpenID Connect Core 1.0. For further details on these specifications, please visit [https://www.hl7.org/fhir/smart-app-launch/](https://www.hl7.org/fhir/smart-app-launch/).\n\n# Terms of Use\n\n## API Usage Terms & Conditions\n\nBy accessing or using our APIs, you agree to the terms outlined below. In the event of any conflict between these terms and other terms provided by us, the other terms will take precedence over these. Collectively, these terms, any additional terms, terms within the accompanying API documentation, and any applicable policies and guidelines are referred to as the \"Terms\". You agree to abide by these Terms, which govern your relationship with us and/or our clients. Therefore, it is essential to carefully review all the Terms.\n\nUnder these Terms, \"EyeMD EMR\" refers to EyeMD EMR Healthcare Systems, Inc., located at 27300 Riverview Center Blvd Suite 100, Bonita Springs, Florida, U.S.A. Throughout the Terms, \"EyeMD EMR\" may be referred to as \"we\", \"our\", or \"us\". \"API\" encompasses the FHIR API system and any endpoints or subsystems referenced in this API documentation.\n\nFurthermore, within these Terms, \"our clients\" or \"Healthcare Provider\" denotes any licensed active user of EyeMD EMR. The term \"You\" or \"Your\" includes anyone acting on your behalf, company employees, contractors, and any individuals who may directly or indirectly access and/or use the API or view information originating from the API.\n\n## Restrictions\n\nYou are prohibited from using the API if: (a) you are not of legal age to enter into a binding contract with EyeMD EMR, (b) you are barred from using or receiving APIs under the laws of the United States, your country of residence, or any other applicable jurisdiction, or (c) you are an Application Vendor that has not received an Application Registration approval.\n\n## Application Registration Requirement\n\nTo gain access to the API, application vendors must submit specific information during the registration approval process. This requirement aims to enhance security and prevent misuse. It's crucial that any registration information provided to EyeMD EMR or our Clients is accurate, complete, and regularly updated.\n\nThe Application Registration approval process includes:\n\n- Ensuring all supplied information is accurate and complete.\n \n- Ensuring all requested scopes are supported and appropriate for the stated use.\n \n- Confirming the request originated from a valid business entity.\n \n- Verifying that the supplied email and URL domain owners match business entity public records. (Email addresses from public/free email provider domains will not be accepted.)\n \n- Ensuring the vendor has not previously been banned for violating these Terms.\n \n- Confirming the request did not originate from a blacklisted IP or domain address.\n \n- Ensuring the request did not originate from a U.S. embargoed or sanctioned country.\n \n- Verifying that the stated reason for the connectivity request is legitimate and healthcare-oriented, serving the needs of patients, practitioners, researchers, or payers.\n \n\nOther Reasons for Registration Denial:\n\n• No valid business entity identifiers (EIN/TIN). \n• Vendor is a data aggregator that does not provide useful apps for patients/practitioners. \n• Non-payment of fees.\n\nFailure to comply with the Terms outlined in this agreement may lead to the revocation of Application Registration privileges and may also result in IP bans as a consequence.\n\n## Compliance with Law, Third-Party Rights, and Other EyeMD EMR Terms of Service\n\nYou must adhere to all applicable laws, regulations, and third-party rights when using the API. It is prohibited to use the API to facilitate, promote, or engage in any illegal activities or infringements upon third-party rights. Additionally, you are not permitted to use the API in a manner that contravenes any other terms of service with EyeMD EMR or our clients.\n\n## Your Companies Employee's, Affiliates and Contractors\n\nYou are required to ensure that your company's employees, affiliates, contractors, and anyone acting on your behalf, including those who may access information provided by the EyeMD EMR API directly or indirectly, comply with (and do not knowingly enable them to violate) applicable laws, regulations, and these Terms.\n\n## Permitted Access\n\nYou should only access the API by the methods described in its documentation. Any assigned credentials should only be used for their intended purposes and should only be used to access records within the assigned access scopes. You must not hide, misrepresent, mask, or spoof your identity or your API Client's identity when using the API.\n\n## API Limitations\n\nEyeMD EMR, our clients, and affiliates may set and enforce limits on your use of the API (e.g., limiting the number of API requests you may make or the number of users you may serve), at their sole discretion. You agree not to attempt to circumvent these limitations as documented with each API. If you wish to use any API beyond these limits, you must obtain express consent from EyeMD EMR, which may decline your request or condition acceptance on your agreement to additional terms and/or charges for that use.\n\n## Security\n\nYou shall use commercially reasonable efforts to protect information accessed by your API Client, including personally identifiable information (PII), from unauthorized access or use. You agree to promptly report any unauthorized access or use of such information to our clients, EyeMD EMR, and any required regulatory agency as required by law. Application vendors should evaluate their applications for the top 10 security vulnerabilities listed at [https://owasp.org/www-project-top-ten/](https://owasp.org/www-project-top-ten/) and ensure their internal systems are patched, scanned for vulnerabilities, and monitored for suspicious activity.\n\n## Ownership\n\nBy using our API, you do not acquire ownership of any rights for our API or the content that is accessed through our API.\n\n## API Prohibitions\n\nWhen using the APIs, you may not (nor allow those acting on your behalf to):\n\n- Sublicense an API for use by a third party. Consequently, you will not create an API Client that functions substantially the same as the API and offer it for use by third parties.\n \n- Perform any action with the intent of introducing to EyeMD EMR products and services any viruses, worms, defects, Trojan horses, malware, or any items of a destructive nature.\n \n- Defame, abuse, harass, stalk, or threaten others.\n \n- Interfere with, overburden, or disrupt the API or the servers or networks providing the API.\n \n- Promote or facilitate unlawful online gambling or disruptive commercial messages or advertisements.\n \n- Remove, obscure, or alter any EyeMD EMR terms of service or any links to or notices of those terms.\n \n\nUnless otherwise specified in writing by us, EyeMD EMR does not intend the use of the API to create obligations under the Health Insurance Portability and Accountability Act, as amended (\"HIPAA\"), and makes no representations that the APIs satisfy HIPAA requirements. If you are (or become) a \"covered entity\" or \"business associate\" as defined in HIPAA, you will not use the API for any purpose or in any manner involving transmitting protected health information to any other party unless you have received prior written consent to such use from us or our clients.\n\n## Confidentiality\n\nAccess credentials (such as passwords, keys, and client IDs) shall only be used by you to identify your API Client and access information intended for you. You will keep your credentials confidential and make commercially reasonable efforts to prevent others from using your credentials. Access credentials shall not be embedded in source code as plain text and shall be encrypted at rest and during transit.\n\nOur communications to you and our APIs may contain patient confidential information. Patient confidential information includes any materials, communications, and information that are marked confidential or that would normally be considered confidential under the circumstances or by HIPAA standards. If you receive any such information, you shall not disclose it to any third party without the patient's prior written consent or approval.\n\n## Representation\n\nYou shall not make any statement regarding your use of our API which suggests partnership with, sponsorship by, or endorsement by EyeMD EMR without our prior written approval.\n\n## Use of Logo and Trademarks.\n\nEyeMD EMR retains exclusive ownership of the trademarks represented by its company name, logo, products, and software. You shall use the name, logo, and trademarks of EyeMD EMR only in a manner approved in writing by EyeMD EMR. You shall not use the term \"EyeMD\" alone to describe any products or services provided by EyeMD EMR Healthcare Systems.\n\nWhen referencing our company or product names in integration literature or any type of written communication, you must use \"EyeMD EMR Healthcare Systems\" or \"EyeMD Electronic Medical Records\" fully spelled out as the first and most prominent use in any context. After this initial use, you may use the abbreviation \"EyeMD EMR\". The words \"EMR,\" \"EMR Healthcare Systems,\" or \"Electronic Medical Records\" must be at least 75% of the size of \"EyeMD\" when used together in written or printed form.\n\nYou shall not challenge the American Academy of Ophthalmology’s registered trademark of the word \"EyeMD\" and will comply with any and all requests made by the American Academy of Ophthalmology regarding the term \"EyeMD\" and its related use with our company, products, and services.\n\n## Limitation of Liability\n\nWhen permitted by law, EyeMD EMR and our clients will not be responsible for the loss of profits, revenues, or data, financial losses, or indirect, special, consequential, exemplary, or punitive damages. To the extent permitted by law, the total liability of EyeMD EMR and our clients for any claim under these Terms, including any implied warranties, is limited to the amount you paid us or our clients to use the applicable API. In all cases, EyeMD EMR and our clients will not be liable for any expense, loss, or damage that is not reasonably foreseeable.\n\n## Indemnification\n\nUnless prohibited by applicable law, if you are a business, you will defend, indemnify, and hold harmless EyeMD EMR and our clients, directors, officers, employees, and users against all liabilities, damages, losses, costs, fees (including legal fees), and expenses relating to any allegation or third-party legal proceeding to the extent arising from:\n\n- Your misuse, your end user's misuse, your contractor's misuse, or anyone acting on your behalf's misuse of the APIs;\n \n- Your violation, your end user's violation, your contractor's violation, or anyone acting on your behalf's violation of the Terms; or\n \n- Any content or data routed into or used with the APIs by you, those acting on your behalf, or your end users.\n \n\n# Exceptions and Errors\n\nStandard http response codes are being used for exceptions. Additional details might be provided by the API in the body of the response.\n\n| Code | Description |\n| --- | --- |\n| 200 | OK - Successful request |\n| 400 | Bad Request - The request is missing information or is malformed |\n| 403 | Forbidden - The request is valid, but the server is refusing action |\n| 404 | Not Found - The requested resource cannot be found |\n| 500 | Internal Server Error - We had a problem with our server |\n\n#### Failed Authentication Error Response Example:\n\n``` json\n{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"025e8d2b-83c4-4087-a614-a174a46dbdb2\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"login\",\n \"diagnostics\": \"Authentication failed.\"\n }\n ]\n}\n\n ```\n\n#### Data Not Found Error Response Example\n\n``` json\n{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"c7b21816-987a-4fd3-b2e2-234ac04d58da\",\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"not-found\",\n \"diagnostics\": \"Resource type 'Patient' with id '60' couldn't be found.\"\n }\n ]\n}\n\n ```\n\n### Pagination\n\nThe API defaults to returning 10 records at a time. If more records are available, a url will be included in the response which can be used to retrieve the next set of records. The url can be found in the link array and is identified with the relation of \"next\".\n\n``` json\n{\n \"resourceType\": \"Bundle\",\n \"id\": \"d3ef8d63-f034-4bd1-889b-8dbd20ebae71\",\n \"meta\": {\n \"lastUpdated\": \"2020-12-14T12:42:31.9869576+00:00\"\n },\n \"type\": \"searchset\",\n \"total\": 42,\n \"link\": [\n {\n \"relation\": \"next\",\n \"url\": \"https://fhir.myeyecarerecords.com/Patient?ct=MTA=\"\n },\n {\n \"relation\": \"self\",\n \"url\": \"https://fhir.myeyecarerecords.com/Patient\"\n }\n ],\n\n ```\n\n#### Changing the Default Record Count\n\nYou can change the amount of returned records by defining the`_count` property as a parameter.\n\n{{base}}/Patient?_count=30\n\n### Search\n\n#### Search Parameter Types\n\nEach search parameter is defined by a type that specifies how the search parameter behaves. These are the defined parameter types:\n\n| [number](https://www.hl7.org/fhir/search.html#number) | Search parameter SHALL be a number (a whole number, or a decimal). |\n| --- | --- |\n| [date](https://www.hl7.org/fhir/search.html#date) | Search parameter is on a date/time. The date format is the standard XML format, though other formats may be supported. |\n| [string](https://www.hl7.org/fhir/search.html#string) | Search parameter is a simple string, like a name part. Search is case-insensitive and accent-insensitive. May match just the start of a string. String parameters may contain spaces. |\n| [token](https://www.hl7.org/fhir/search.html#token) | Search parameter on a coded element or identifier. May be used to search through the text, display, code and code/codesystem (for codes) and label, system and key (for identifier). Its value is either a string or a pair of namespace and value, separated by a \" |\n| [reference](https://www.hl7.org/fhir/search.html#reference) | A reference to another resource (Reference or canonical). |\n| [composite](https://www.hl7.org/fhir/search.html#composite) | A composite search parameter that combines a search on two values together. |\n| [quantity](https://www.hl7.org/fhir/search.html#quantity) | A search parameter that searches on a quantity. |\n| [uri](https://www.hl7.org/fhir/search.html#uri) | A search parameter that searches on a URI (RFC 3986). |\n| [special](https://www.hl7.org/fhir/search.html#special) | Special logic applies to this parameter per the description of the search parameter. |\n\n# USCDI Mappings\n\n## Allergies and Intolerances\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Allergies and Intolerances | [US Core AllergyIntolerance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-allergyintolerance.html) | AllergyIntolerance |\n| Substance (Medication) | [US Core AllergyIntolerance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-allergyintolerance.html) | AllergyIntolerance |\n| Substance (Drug Class) | [US Core AllergyIntolerance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-allergyintolerance.html) | AllergyIntolerance |\n| Reaction | [US Core AllergyIntolerance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-allergyintolerance.html) | AllergyIntolerance |\n\n---\n\n## Assessment and Plan of Treatment\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Assessment and Plan of Treatment | [US Core CarePlan Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careplan.html) | CarePlan |\n| Assessment | [US Core CarePlan Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careplan.html) | CarePlan |\n| Plan of Treatment | [US Core CarePlan Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careplan.html) | CarePlan |\n| SDOH Assessment | [US Core Simple Observation Profile
](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html)[US Core Observation Screening Assessment Profile](https://hl7.org/fhir/us/core/StructureDefinition-us-core-observation-screening-assessment.html)
[US Core QuestionnaireResponse Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-questionnaireresponse.html) | Observation
QuestionnaireResponse |\n\n---\n\n## Care Team Members\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Care Team Members | [US Core CareTeam Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html) | CareTeam |\n| Name | [US Core CareTeam Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html) | CareTeam |\n| Role | [US Core CareTeam Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html) | CareTeam |\n| Location | [US Core CareTeam Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html) | CareTeam |\n| Telecom | [US Core CareTeam Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html) | CareTeam |\n| Identifier | [US Core CareTeam Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-careteam.html) | CareTeam |\n\n---\n\n## Clinical Notes\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Clinical Notes | [US Core DocumentReference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html) | DocumentReference |\n| Consultation Note | [US Core DocumentReference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html) | DocumentReference |\n| Discharge Summary Note | [US Core DocumentReference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html) | DocumentReference |\n| History & Physical | [US Core DocumentReference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html) | DocumentReference |\n| Procedure Note | [US Core DocumentReference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html) | DocumentReference |\n| Progress Note | [US Core DocumentReference Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html) | DocumentReference |\n\n---\n\n## Clinical Tests\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Clinical Tests | [US Core Observation Clinical Result Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-clinical-result.html) | Observation |\n| Clinical Test | [US Core Observation Clinical Result Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-clinical-result.html) | Observation |\n| Clinical Test Result / Report | [US Core Observation Clinical Result Profile
](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-clinical-result.html)[US Core DiagnosticReport Profile – Notes](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-note.html) | Observation
DiagnosticReport |\n\n---\n\n## Diagnostic Imaging\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Diagnostic Imaging | [US Core Observation Clinical Result Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-clinical-result.html) | Observation |\n| Diagnostic Imaging Test | [US Core Observation Clinical Result Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-clinical-result.html) | Observation |\n| Diagnostic Imaging Result / Report | [US Core DiagnosticReport Profile – Notes](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-note.html) | DiagnosticReport |\n\n---\n\n## Encounter\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Encounter | [US Core Encounter Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html) | Encounter |\n| Type | [US Core Encounter Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html) | Encounter |\n| Diagnosis | [US Core Condition Encounter Diagnosis Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-encounter-diagnosis.html) | Condition |\n| Time | [US Core Encounter Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html) | Encounter |\n| Location | [US Core Encounter Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html) | Encounter |\n| Disposition | [US Core Encounter Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-encounter.html) | Encounter |\n\n---\n\n## Goals\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Goals | [US Core Goal Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-goal.html) | Goal |\n| Patient Goals | [US Core Goal Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-goal.html) | Goal |\n| SDOH Goals | [US Core Goal Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-goal.html) | Goal |\n\n---\n\n## Health Insurance Information\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Health Insurance Information | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Coverage Status | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Coverage Type | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Relationship to Subscriber | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Member Identifier | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Subscriber Identifier | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Group Number | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n| Payer Identifier | [US Core Coverage Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-coverage.html) | Coverage |\n\n---\n\n## Health Status / Assessments\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Health Status / Assessments | [US Core Simple Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html) | Observation |\n| Health Concerns | [US Core Condition Problems and Health Concerns Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html) | Condition |\n| Functional Status | [US Core Simple Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html) | Observation |\n| Disability Status | [US Core Simple Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html) | Observation |\n| Mental Status | [US Core Simple Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html) | Observation |\n| Cognitive Status | [US Core Simple Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-simple-observation.html) | Observation |\n| Pregnancy Status | [US Core Observation Pregnancy Status Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-pregnancy-status.html) | Observation |\n| Pregnancy Intent | [US Core Observation Pregnancy Intent Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-pregnancy-intent.html) | Observation |\n| Smoking Status | [US Core Smoking Status Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-smokingstatus.html) | Observation |\n\n---\n\n## Immunizations\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Immunizations | [US Core Immunization Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-immunization.html) | Immunization |\n\n---\n\n## Laboratory\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Laboratory | [US Core Laboratory Result Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-lab.html) | Observation |\n| Laboratory Test | [US Core Laboratory Result Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-lab.html) | Observation |\n| Laboratory Result | [US Core Laboratory Result Observation Profile
](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-lab.html)[US Core DiagnosticReport Profile – Lab](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-diagnosticreport-lab.html) | Observation
DiagnosticReport |\n| Result Status | [US Core Laboratory Result Observation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-lab.html) | Observation |\n| Specimen Type | [US Core Specimen Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-specimen.html) | Specimen |\n\n---\n\n## Medications\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Medications | [US Core Medication Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medication.html) | Medication |\n| Dose | [US Core MedicationRequest Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html) | MedicationRequest |\n| Dose Unit of Measure | [US Core MedicationRequest Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html) | MedicationRequest |\n| Indication | [US Core MedicationRequest Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationrequest.html) | MedicationRequest |\n| Fill Status | [US Core MedicationDispense Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-medicationdispense.html) | MedicationDispense |\n\n---\n\n## Patient Demographics\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Patient Demographics | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Name | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| First Name | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Last Name | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Middle Name (Including middle initial) | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Name Suffix | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Previous Name | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Date of Birth | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Date of Death | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Sex | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Sexual Orientation | [US Core Observation Sexual Orientation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-sexual-orientation.html) | Observation |\n| Gender Identity | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Race | [US Core Race Extension](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-race.html) | Patient |\n| Ethnicity | [US Core Ethnicity Extension](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-ethnicity.html) | Patient |\n| Tribal Affiliation | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Preferred Language | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Current Address | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Previous Address | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Phone Number | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Phone Number Type | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Email Address | [US Core Patient Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-patient.html) | Patient |\n| Related Person's Name | [US Core RelatedPerson Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-relatedperson.html) | RelatedPerson |\n| Related Person's Relationship | [US Core RelatedPerson Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-relatedperson.html) | RelatedPerson |\n| Occupation | [US Core Observation Occupation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-occupation.html) | Observation |\n| Occupation Industry | [US Core Observation Occupation Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-observation-occupation.html) | Observation |\n\n---\n\n## Problems\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Problems | [US Core Condition Problems and Health Concerns Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html) | Condition |\n| Problem | [US Core Condition Problems and Health Concerns Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html) | Condition |\n| Date of Diagnosis | [US Core Condition Problems and Health Concerns Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html) | Condition |\n| Date of Resolution | [US Core Condition Problems and Health Concerns Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html) | Condition |\n| SDOH Problems / Health Concerns | [US Core Condition Problems and Health Concerns Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-condition-problems-health-concerns.html) | Condition |\n\n---\n\n## Procedures\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Procedures | [US Core Procedure Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-procedure.html) | Procedure |\n| Procedure | [US Core Procedure Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-procedure.html) | Procedure |\n| Reason for Referral | [US Core ServiceRequest Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-servicerequest.html) | ServiceRequest |\n| SDOH Interventions | [US Core ServiceRequest Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-servicerequest.html) | ServiceRequest |\n\n---\n\n## Provenance\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Provenance | [US Core Provenance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-provenance.html) | Provenance |\n| Author Time Stamp | [US Core Provenance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-provenance.html) | Provenance |\n| Author Organization | [US Core Provenance Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-provenance.html) | Provenance |\n\n---\n\n## Unique Device Identifiers\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Unique Device Identifiers | [US Core Implantable Device Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-implantable-device.html) | Device |\n| UDI for Patient Implantable Device | [US Core Implantable Device Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-implantable-device.html) | Device |\n\n---\n\n## Vital Signs\n\n| USCDI v3 Data Class / Data Element | US Core Profile | FHIR Resource |\n| --- | --- | --- |\n| Vital Signs | [US Core Vital Signs Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-vital-signs.html) | Observation |\n| Systolic Blood Pressure | [US Core Blood Pressure Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-blood-pressure.html) | Observation |\n| Diastolic Blood Pressure | [US Core Blood Pressure Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-blood-pressure.html) | Observation |\n| Body Height | [US Core Body Height Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-body-height.html) | Observation |\n| Body Weight | [US Core Body Weight Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-body-weight.html) | Observation |\n| Body Temperature | [US Core Body Temperature Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-body-temperature.html) | Observation |\n| Heart Rate | [US Core Heart Rate Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-heart-rate.html) | Observation |\n| Respiratory Rate | [US Core Respiratory Rate Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-respiratory-rate.html) | Observation |\n| Pulse Oximetry | [US Core Pulse Oximetry Profile](https://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-pulse-oximetry.html) | Observation |\n\n# Detailed Change Log\n\n## New in USCDI v3 (not present in v1)\n\n| USCDI v3 Data Class | New Data Elements |\n| --- | --- |\n| **Health Status / Assessments** | Functional Status
Disability Status
Mental Status
Cognitive Status |\n| **Health Status / Assessments** | Pregnancy Intent |\n| **Problems** | SDOH Problems / Health Concerns |\n| **Goals** | SDOH Goals |\n| **Procedures** | SDOH Interventions |\n| **Assessment and Plan of Treatment** | SDOH Assessment |\n| **Unique Device Identifiers** | UDI for Patient Implantable Devices |\n\n# API Implementation requirements\n\n1. Client must support FHIR version 4.\n \n2. Client must support TLS 1.2.\n \n3. Client must acquire access tokens using the OpenID Connect standard and provided credentials (when applicable).\n \n\n# API Syntax, Functions, Responses","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11861301","collectionId":"c25240ee-3125-4bb6-b61a-2183e1a6040c","publishedId":"TVewYPfd","public":true,"publicUrl":"https://documenter-api.postman.tech/view/11861301/TVewYPfd","privateUrl":"https://go.postman.co/documentation/11861301-c25240ee-3125-4bb6-b61a-2183e1a6040c","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2C3992"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-12-11T19:07:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVewYPfd"}