"}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Security & Authorization Flow","item":[],"id":"176aea5c-e2e3-4ca7-8cbf-c8372e87ea62","description":"Security
\nLike many RESTful APIs, the Carefluence OpenAPI R4 uses OAuth 2 for security. This means that when making calls to any resource with the Carefluence OpenAPI R4, you must pass a Bearer token. This token is passed in the Authorization Header.
\nAuthorization: Bearer 123.456.7890\n\n
To obtain a Bearer token, you must call an Authorization Server. The authorization server typically exposes two endpoints:
\n\nauthorize: typically used to confirm the user’s credentialstoken: used to obtain the Bearer token
\nAs per the FHIR specification, the Carefluence OpenAPI R4 supports both JSON and XML. However, for simplicity, we limit our examples to JSON.
\nAuthorization flow
\nThe Carefluence OpenAPI R4 uses OAuth 2 and Open ID Connect. It is based on the Smart Authorization description.
\nReferences:
\n\nThe authorization code grant type is the only grant type supported in this release because it is considered secure. Other grant types, such as implicit flow, may be supported in future as the standards evolve.
\nThe following diagram (from Smart) describes the authorization code flow:
\n![](\"https://developer.allscripts.com/Content/fhir/images/Smart_Authorization.png\")
\nOnce the patient or provider (hereafter referred to as the user) launches the app, you must authenticate the user by calling the authorize endpoint on the authorization server used by the EHR.
\nDuring the authentication step, provide the app’s client_id, but not the secret.
\n\nNote that the examples here illustrate what is happening. It is not recommended that you code an OAuth client yourself. For suggestions on OAuth clients, see link.
\n
\nGET https://admin.carefluence.com/connect/authorize?response_type=code&client_id=d34d06b8-63ff-414b-a93c-11dc998f54e1&redirect_uri=http://localhost:8000/launch.html&scope=launch openid profile\n\n
If you are developing a web client, you will use a URL pointing back to your website.
\nDuring the On Approval step, the user will be asked to log in. If they do not have credentials, they will be asked to confirm their identity before creating credentials. If this is the first time they have used the app, they will be asked to confirm that they want to use the application (authorizing the application).
\nAfter the user authenticates, you will receive an authorization code. You send the authorization code, along with the client_secret, to the token endpoint of the authorization server.
\nPOST https://admin.carefluence.com/connect/token\n code f53e501a51f2909d1f7ac5dd0d148c46\n redirect_uri http://localhost:8000/launch.html\n client_id C85533AE-E3A4-455C-BE5C-DAC0F695408F\n scope patient/*.read\n client_secret supersecret\n grant_type authorization_code\n\n
The server returns the access token which the app then uses in subsequent calls to the API.
\n{\n \"access_token\" : 123.456.7890\n \"expires_in\": 1200,\n \"token_type\": \"Bearer\" \n}\n\n
Scopes
\nThe Carefluence OpenAPI R4 authorization server uses the scopes defined for Smart on FHIR.
\nConfidential and public clients
\nThe Carefluence OpenAPI R4 supports two type of clients: confidential clients and public clients.
\nConfidential clients are clients that can be trusted to keep the client_secret secure. Examples of confidential clients include:
\n\n- Web clients written as server side HTML and where the client secret is stored on the server
\n- Mobile clients written in the native technology of the platform
\n
\nPublic clients cannot be trusted to keep the secret safe.
\nUsing a refresh token
\nTo prevent a user from having to log in whenever the access token expires, use a refresh token. The refresh token will be valid for hours/days.
\nTo get a new access token, call the token endpoint of the authorization server and present your bearer token.
\nIf the bearer token has expired, you must call the authorization endpoint of the authorization server again so the user can login using their credentials.
\nAuthorization for patient access
\nCertain resources and operation on the Carefluence OpenAPI R4 are not specific to a patient. For example, searching for a patient.
\nHowever, most API calls are patient specific. For example, retrieving patient demographics or problems.
\nIn those cases the following authorization rules apply:
\n\n- If the user is a patient:
\n- They have access to their own data.
\n- They have access to patients for whom they are caregivers or guardian.
\n- They will not have access to the data for any other patients.
\n
\n \n- If the user is a provider or other EHR user:
\n- They only have access to patients they are authorized to see in their EHR.
\n- They do not have access to patients they are not authorized to see in their EHR.
\n- Apps do not have access to the “break glass” privilege escalation functionality.
\n
\n \n
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"cd804883-f10e-4b98-a9aa-45a0a37b6945"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"35f2a6f7-2497-473d-ab84-5c5cd1a59527"}}],"_postman_id":"176aea5c-e2e3-4ca7-8cbf-c8372e87ea62"},{"name":"Multi-factor Authentication Option","item":[],"id":"177b5b5e-0588-4d62-9be7-661299d22045","description":"Carefluence OpenAPI R4 supports Multi-factor Authentication for the API Administrators, Developers, Patients who needs to authenticate for token or system access purposes.
\nWe use Carefluence SMART Connect module for MFA and it is an optional add-on feature to the OpenAPI platform. When the Multi-factor authentication is turned ON, the following use cases are turned ON for the respective users.
\n\n- Use case 1 : API Administrators, when they login to the Carefluence Admin portal for API management, they will be sent a verification code via Email/text message and that needs to be keyed into the login page -> verification code to access the system.
\n- Use case 2 : Self-registered API developers, when they login to the Carefluence Admin portal for their App registration or to request token for their Applications, they will be sent a verification code via Email/text message and that needs to be keyed into the login page -> verification code to access the system.
\n- Use case 3 : Patients, when they are presented Authorization dialog with scopes to grant permission during the API calls, they are required to login prior to the Carefluence Admin portal to generate token for the API access further. In this workflow, they will be sent a verification code via Email/text message to the phone number or email that they registered in EHR, Carefluence platform matches the patient and accesses this information via OpenAPI. This verification code needs to be keyed into the login page to access the APIs further.
\n
\nNote: Carefluence SMART Connect module usage is an option when the OpenAPI platform is deployed in Microsoft Azure. But Carefluence OpenAPI R4 can work with other MFA providers as on needed basis of the customers and we support the above use cases irrespective of the MFA provider implemented in the project.
\n","_postman_id":"177b5b5e-0588-4d62-9be7-661299d22045","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Client Registration","item":[],"id":"eb9d0e05-3162-4a97-8cc6-b33e2b5d2675","description":"\n- Carefluence OpenAPI Clients have to create a Developer Account by signing up here RegisterUser - Carefluence
\n- Once registered, developers can login and register their Applications
Developer Login - Carefluence \n
\n","_postman_id":"eb9d0e05-3162-4a97-8cc6-b33e2b5d2675","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Errors & Exceptions","item":[],"id":"f60c4124-b63f-4494-a476-b923b9010fb4","description":"Errors & Exception Codes
\n\n\n\n| Code | \nMeaning | \n
\n\n\n\n| 200 | \nThe request was processed appropriately. | \n
\n\n| 400 | \nInvalid parameter. | \n
\n\n| 401 | \nThe request did not have a valid authorization token or none was provided. Obtain a valid authorization token and add it to the authorization header. | \n
\n\n| 403 | \nThe user is not authorized for the operation. The user may not have access to the patient, or an invalid scope was provided. | \n
\n\n| 4xx | \nAuthorization error. | \n
\n\n
\n
A response with a code in the 4xx or 5xx may contain addtional information in the form of a FHIR OperationOutcome.
\nFor example:
\n{\n \"resourceType\": \"OperationOutcome\",\n \"id\": \"101\",\n \"text\": {\n \"status\": \"additional\",\n \"div\": \"\\n W is not a recognized code for Gender.\\n \"\n },\n \"issue\": [\n {\n \"severity\": \"error\",\n \"code\": \"code-invalid\",\n \"details\": {\n \"text\": \"The code \\\"W\\\" is not known and not legal in this context\"\n },\n \"diagnostics\": \"Acme.Interop.FHIRProcessors.Patient.processGender line 2453\",\n \"location\": [\n \"/f:Person/f:gender\"\n ]\n }\n ]\n}\n\n
","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"fc0be61e-a04a-4b53-8f7a-94ee49cf1b3a"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"2b4e8698-c87a-4d19-9081-564771c1018e"}}],"_postman_id":"f60c4124-b63f-4494-a476-b923b9010fb4"},{"name":"OpenAPI R4 Platform Components","item":[],"id":"6158d10b-3a07-484e-81de-ea442b65b0d4","description":"Powered by Carefluence OpenAPI platform, Carefluence OpenAPI adopted HL7 FHIR® in its core strategy around any healthcare system or medical device. The FHIR® Standard has brought a resource approach to the Carefluence OpenAPI server information model (ie., Patient, Condition, Procedure, or Immunization), which is more granular than any other standard and fast to learn, develop, and implement solutions.
\n\n- Authorization Service: Web-based SMART authorization and resource retrieval service developed on OAuth 2.0 specification.
\n- SMART Connect: Multi-factor Authentication & Application Single-Sign on and Security Options
\n- RESTful Resource API: Healthcare data (ie., Patient, Condition, Procedure, or Immunization) is securely hosted as resources on a web server. All of these resources can be searched and operations such as update, create or delete are implemented as specified by FHIR® R4 Standard.
\n- FHIR® Transformer: Server side component that takes CCDA or HL7 V2 messages as input and convert them into FHIR® resources accessible via RESTful Resource API.
\n- Embeddable Viewer Plugin: A default embeddable patient data viewer is provided and can be customized using CSS and XSLT.
\n- HL7 Interface Engine Plugin: Add-on modules to use with Mirth Connect as the HL7 interface engine.
\n- OpenAPI Database: Database agnostic storage for the Carefluence platform that is tested with MS SQL server. Based on the Carefluence implementation strategy, there is an option to choose Oracle, MySQL, or PostgreSQL.
\n- Authorization Database: MS SQL Server data store to manage OAuth tokens and client application registrations with their authorization statuses
\n- Cloud Native Hosting : Carefluence OpenAPI R4 is hosted in Microsoft Azure as App Services natively for our Development purposes. For our customers, the Azure reference implementation will be licensed to subscribe in their own Azure Account or lease ours.
\n- EHR Connectivity: Carefluence develop and maintain HL7 standards based adapters to connect with EHRs and normalize to FHIR R4 standards. Typically Carefluence professional services team will assess whether to use one of their standards based adapter or develop a custom adapter for the data exchange purposes.
\n
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"6a7d42ca-ddce-456f-beb1-e248e41df396"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"71669ba5-a8b7-4756-91e8-763f8f7e2108"}}],"_postman_id":"6158d10b-3a07-484e-81de-ea442b65b0d4"},{"name":"Resources","item":[{"name":"Search Resources By Date Range","item":[{"name":"Observations By Date Range","id":"adf5ad26-a63f-4a5a-947b-9e2141be9e70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Observation?patient={{PatientID}}&date=ge2019-07-01&date=le2023-10-17","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Observation"],"host":["{{BaseURL}}"],"query":[{"key":"patient","value":"{{PatientID}}"},{"key":"date","value":"ge2019-07-01"},{"key":"date","value":"le2023-10-17"}],"variable":[]}},"response":[],"_postman_id":"adf5ad26-a63f-4a5a-947b-9e2141be9e70"}],"id":"30647ac7-222d-47d1-ac42-9b13b42c9000","description":"Our OpenAPI Platform supports the search any resource by a specific date or date ranges. Every FHIR resource has some kind of a date parameter that can be searched on.
\n\n- The date parameter format is
yyyy-mm-dd \n
\nFor example,
\n\nWhen you want to search Observation resource to include part of 14th Jan 2023 before 10AM results, you will need to pass in the URL date=lt2013-01-14T10:00
\nWhen you want to search Observation resource to include results received on or after of of 14-Jan 2013 after 10am, you will pass in the URL date=gt2013-01-14T10:00
\nWhen you want to search Observation resource to include results received from 21-Jan 2013 onwards to 14-Mar 2013, you will pass in the URL date=ge2013-01-23&date=le2013-03-14
\n
\n","_postman_id":"30647ac7-222d-47d1-ac42-9b13b42c9000","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Pagination","item":[{"name":"Demographics","item":[{"name":"First Page","id":"4d57e519-9a0b-4bc2-959b-d5db44d5ca24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Patient?gender=male&page=1&_count=20","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Patient"],"host":["{{BaseURL}}"],"query":[{"key":"gender","value":"male"},{"key":"page","value":"1"},{"key":"_count","value":"20"}],"variable":[]}},"response":[],"_postman_id":"4d57e519-9a0b-4bc2-959b-d5db44d5ca24"},{"name":"Second Page","id":"7058fb84-f9de-4ba8-8f1a-f3c206c614bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Patient?gender=male&searchId=&page=2&_count=20","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Patient"],"host":["{{BaseURL}}"],"query":[{"key":"gender","value":"male"},{"key":"searchId","value":""},{"key":"page","value":"2"},{"key":"_count","value":"20"}],"variable":[]}},"response":[],"_postman_id":"7058fb84-f9de-4ba8-8f1a-f3c206c614bc"},{"name":"Third Page","id":"d7fb4f24-1f61-4e5c-bce9-cc4c9e894cdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Patient?gender=male&searchId=&page=3&_count=20","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Patient"],"host":["{{BaseURL}}"],"query":[{"key":"gender","value":"male"},{"key":"searchId","value":""},{"key":"page","value":"3"},{"key":"_count","value":"20"}],"variable":[]}},"response":[],"_postman_id":"d7fb4f24-1f61-4e5c-bce9-cc4c9e894cdd"}],"id":"2bd68df8-ce5e-486d-ad13-62128ad83469","_postman_id":"2bd68df8-ce5e-486d-ad13-62128ad83469","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Observation","item":[{"name":"FirstPage","id":"eb56d1a7-8ca7-4fb9-9aa4-e50bff572ff0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Observation?patient={{PatientID}}&date=ge2019-07-01&date=le2023-10-17&page=1&_count=10","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Observation"],"host":["{{BaseURL}}"],"query":[{"key":"patient","value":"{{PatientID}}"},{"key":"date","value":"ge2019-07-01"},{"key":"date","value":"le2023-10-17"},{"key":"page","value":"1"},{"key":"_count","value":"10"}],"variable":[]}},"response":[],"_postman_id":"eb56d1a7-8ca7-4fb9-9aa4-e50bff572ff0"},{"name":"Second Page","id":"d507ad42-32f4-4dc4-b853-1b0363d47d61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Observation?patient={{PatientID}}&date=ge2019-07-01&date=le2023-10-17&page=2&_count=10","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Observation"],"host":["{{BaseURL}}"],"query":[{"key":"patient","value":"{{PatientID}}"},{"key":"date","value":"ge2019-07-01"},{"key":"date","value":"le2023-10-17"},{"key":"page","value":"2"},{"key":"_count","value":"10"}],"variable":[]}},"response":[],"_postman_id":"d507ad42-32f4-4dc4-b853-1b0363d47d61"}],"id":"42649b62-27a2-4f09-82c4-ccdf19cd3ddb","_postman_id":"42649b62-27a2-4f09-82c4-ccdf19cd3ddb","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Condition","item":[{"name":"FirstPage","id":"a4549a41-ea69-48f4-8ee7-276fbdeb016f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{BaseURL}}/Condition?patient={{PatientID}}&page=1&_count=10","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Condition"],"host":["{{BaseURL}}"],"query":[{"key":"patient","value":"{{PatientID}}"},{"key":"page","value":"1"},{"key":"_count","value":"10"}],"variable":[]}},"response":[],"_postman_id":"a4549a41-ea69-48f4-8ee7-276fbdeb016f"},{"name":"Second Page","id":"fdc7ffe0-9804-476f-8042-732af44b5980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mmdpcf.Carefluence.com/cf.fhir.r4/Condition?patient={{PatientID}}&searchId=&page=2&_count=10","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"protocol":"https","path":["cf.fhir.r4","Condition"],"host":["mmdpcf","Carefluence","com"],"query":[{"key":"patient","value":"{{PatientID}}"},{"key":"searchId","value":""},{"key":"page","value":"2"},{"key":"_count","value":"10"}],"variable":[]}},"response":[],"_postman_id":"fdc7ffe0-9804-476f-8042-732af44b5980"}],"id":"2888923d-aa18-4e45-895e-f439f51e10b3","_postman_id":"2888923d-aa18-4e45-895e-f439f51e10b3","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"AlegryIntolerance","item":[{"name":"Third Page","item":[{"name":"Third page","id":"3ba0e1ae-4ad4-47a1-ab8c-9363de643dbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"3ba0e1ae-4ad4-47a1-ab8c-9363de643dbc"}],"id":"b93e82c0-97a8-4c63-8027-d34d6376aa24","_postman_id":"b93e82c0-97a8-4c63-8027-d34d6376aa24","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Firstpage","id":"9dbfd516-6966-4ba4-81c8-271afc165111","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"9dbfd516-6966-4ba4-81c8-271afc165111"},{"name":"2nd page","id":"393f6a16-aa3b-4b14-89c3-3dfc12ddc0c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"393f6a16-aa3b-4b14-89c3-3dfc12ddc0c4"}],"id":"1358c8eb-a9d9-4041-9553-9005eac7570b","_postman_id":"1358c8eb-a9d9-4041-9553-9005eac7570b","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"DocumentReference","item":[],"id":"74513d82-a442-4b85-861f-8056a110c600","_postman_id":"74513d82-a442-4b85-861f-8056a110c600","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}}],"id":"d51e9d61-167c-4dc6-b3b1-aabb681eff88","description":"In order to keep the load on clients, servers and the network minimized, our OpenAPI server supports pagination to return the results in a series of pages. The search result set for resources will contain the URLs that the client uses to request additional pages from the search set.
\nImplementation References Search - FHIR v4.0.1 (hl7.org)
\n_total is an option parameter in URL. Our OpenAPI Server ignores this parameter sent by the Clients. Reference Search - FHIR v4.0.1 (hl7.org)
\nRefer to the Bundle reference documentation Http - FHIR v4.0.1 (hl7.org). When we return the resultset, our bundle response optionally present the return links to first, previous & next result sets.
\n","_postman_id":"d51e9d61-167c-4dc6-b3b1-aabb681eff88","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}}},{"name":"Patient","item":[{"name":"Search Patient by _id","id":"4630c341-ecee-4774-8da5-c5ba9226ce9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"_id","value":"UMR176482","type":"text"},{"key":"_id","value":"{{PatientID}}","type":"text","uuid":"f276b3ca-4395-4adf-be2b-f8ecf60814db","disabled":true}]},"url":"{{BaseURL}}/Patient/_search","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"{{scope}}"},{"key":"clientSecret","value":"{{client_secret}}"},{"key":"clientId","value":"{{client_id}}"},{"key":"accessTokenUrl","value":"{{TokenUrl}}"},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","id":"5f4d459b-f67a-49b2-9cee-58ea7a028d75","name":"Carefluence OpenAPI R4 - Suvarna","type":"collection"}},"urlObject":{"path":["Patient","_search"],"host":["{{BaseURL}}"],"query":[],"variable":[]}},"response":[{"id":"ea4a434e-69a9-43b1-b7fd-15c0cbfc1b98","name":"Search Patient by _id","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"_id","value":"4","type":"text"}]},"url":"{{BaseURL}}/Patient/_search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"5163"},{"key":"Content-Type","value":"application/fhir+json; charset=utf-8"},{"key":"Date","value":"Wed, 15 Jun 2022 11:36:25 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"private"},{"key":"Set-Cookie","value":"ARRAffinity=4e7f4f4cfa46c4b376296b4f9c09f94856a0db3ea477bc4d183a284847b23db0;Path=/;HttpOnly;Secure;Domain=mmdcf.Carefluence.com"},{"key":"Set-Cookie","value":"ARRAffinitySameSite=4e7f4f4cfa46c4b376296b4f9c09f94856a0db3ea477bc4d183a284847b23db0;Path=/;HttpOnly;SameSite=None;Secure;Domain=mmdcf.Carefluence.com"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceType\": \"Bundle\",\n \"total\": 0,\n \"link\": [\n {\n \"relation\": \"self\",\n \"url\": \"https://mmdcf.Carefluence.com/cf.fhir.r4/Patient?_id=4&searchId=&page=1&_count=20&startIndex=0&_total=0\"\n }\n ],\n \"entry\": [\n {\n \"resource\": {\n \"resourceType\": \"Patient\",\n \"id\": \"4\",\n \"extension\": [\n {\n \"extension\": [\n {\n \"url\": \"ombCategory\",\n \"valueCoding\": {\n \"system\": \"urn:oid:2.16.840.1.113883.6.238\",\n \"code\": \"2106-3\",\n \"display\": \"White\"\n }\n },\n {\n \"url\": \"text\",\n \"valueString\": \"White\"\n }\n ],\n \"url\": \"http://hl7.org/fhir/us/core/StructureDefinition/us-core-race\"\n },\n {\n \"extension\": [\n {\n \"url\": \"ombCategory\",\n \"valueCoding\": {\n \"system\": \"urn:oid:2.16.840.1.113883.6.238\",\n \"code\": \"2186-5\",\n \"display\": \"Non Hispanic or Latino\"\n }\n },\n {\n \"url\": \"text\",\n \"valueString\": \"Non Hispanic or Latino\"\n }\n ],\n \"url\": \"http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity\"\n },\n {\n \"url\": \"http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName\",\n \"valueString\": \"Emelina469 Hilpert278\"\n },\n {\n \"url\": \"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex\",\n \"valueCode\": \"M\"\n },\n {\n \"url\": \"http://hl7.org/fhir/StructureDefinition/patient-birthPlace\",\n \"valueAddress\": {\n \"city\": \"Revere\",\n \"state\": \"Massachusetts\",\n \"country\": \"US\"\n }\n },\n {\n \"url\": \"http://synthetichealth.github.io/synthea/disability-adjusted-life-years\",\n \"valueDecimal\": 1.2127307844815787\n },\n {\n \"url\": \"http://synthetichealth.github.io/synthea/quality-adjusted-life-years\",\n \"valueDecimal\": 77.78726921551842\n }\n ],\n \"identifier\": [\n {\n \"use\": \"usual\",\n \"type\": {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0203\",\n \"code\": \"MR\"\n }\n ]\n },\n \"system\": \"urn:oid:1.2.36.146.595.217.0.1\",\n \"value\": \"12345\",\n \"period\": {\n \"start\": \"2001-05-06\"\n },\n \"assigner\": {\n \"display\": \"Acme Healthcare\"\n }\n }\n ],\n \"active\": true,\n \"name\": [\n {\n \"use\": \"official\",\n \"family\": \"Chalmers\",\n \"given\": [\n \"Peter\",\n \"James\"\n ]\n },\n {\n \"use\": \"usual\",\n \"given\": [\n \"Jim\"\n ]\n },\n {\n \"use\": \"maiden\",\n \"family\": \"Windsor\",\n \"given\": [\n \"Peter\",\n \"James\"\n ],\n \"period\": {\n \"end\": \"2002\"\n }\n }\n ],\n \"telecom\": [\n {\n \"system\": \"phone\",\n \"value\": \"(03) 5555 6473\",\n \"use\": \"work\",\n \"rank\": 1\n },\n {\n \"system\": \"phone\",\n \"value\": \"(03) 3410 5613\",\n \"use\": \"mobile\",\n \"rank\": 2\n },\n {\n \"system\": \"phone\",\n \"value\": \"(03) 5555 8834\",\n \"use\": \"old\",\n \"period\": {\n \"end\": \"2014\"\n }\n }\n ],\n \"gender\": \"male\",\n \"birthDate\": \"1974-12-25\",\n \"_birthDate\": {\n \"extension\": [\n {\n \"url\": \"http://hl7.org/fhir/StructureDefinition/patient-birthTime\",\n \"valueDateTime\": \"1974-12-25T14:35:45-05:00\"\n }\n ]\n },\n \"deceasedBoolean\": false,\n \"address\": [\n {\n \"use\": \"home\",\n \"type\": \"both\",\n \"text\": \"534 Erewhon St PeasantVille, Rainbow, Vic 3999\",\n \"line\": [\n \"534 Erewhon St\"\n ],\n \"city\": \"PleasantVille\",\n \"district\": \"Rainbow\",\n \"state\": \"Vic\",\n \"postalCode\": \"3999\",\n \"period\": {\n \"start\": \"1974-12-25\"\n }\n }\n ],\n \"contact\": [\n {\n \"relationship\": [\n {\n \"coding\": [\n {\n \"system\": \"http://terminology.hl7.org/CodeSystem/v2-0131\",\n \"code\": \"N\"\n }\n ]\n }\n ],\n \"name\": {\n \"family\": \"du Marché\",\n \"_family\": {\n \"extension\": [\n {\n \"url\": \"http://hl7.org/fhir/StructureDefinition/humanname-own-prefix\",\n \"valueString\": \"VV\"\n }\n ]\n },\n \"given\": [\n \"Bénédicte\"\n ]\n },\n \"telecom\": [\n {\n \"system\": \"phone\",\n \"value\": \"+33 (237) 998327\"\n }\n ],\n \"address\": {\n \"use\": \"home\",\n \"type\": \"both\",\n \"line\": [\n \"534 Erewhon St\"\n ],\n \"city\": \"PleasantVille\",\n \"district\": \"Rainbow\",\n \"state\": \"Vic\",\n \"postalCode\": \"3999\",\n \"period\": {\n \"start\": \"1974-12-25\"\n }\n },\n \"gender\": \"female\",\n \"period\": {\n \"start\": \"2012\"\n }\n }\n ],\n \"communication\": [\n {\n \"language\": {\n \"coding\": [\n {\n \"system\": \"urn:ietf:bcp:47\",\n \"code\": \"en-US\",\n \"display\": \"English\"\n }\n ],\n \"text\": \"English\"\n }\n }\n ],\n \"managingOrganization\": {\n \"reference\": \"Organization/1\"\n }\n }\n }\n ]\n}"}],"_postman_id":"4630c341-ecee-4774-8da5-c5ba9226ce9b"}],"id":"4c1b2eae-aca7-44ab-981f-3e1d5c1de77e","description":"This resource conforms to USCDI profile for Patient Demographics - refer to USCore Patient Profile. Patient resource response can be requested in JSON or XML format as per FHIR standard R4 version Patient - FHIR v4.0.1 (hl7.org) supports the following data for Patient
\n\n\n\n| USCore Data Element | \nFHIR Resource Data | \n
\n\n\n\nFirst Name
Middle Name | \nPatient.name.given | \n
\n\n| Last Name | \nPatient.name.family | \n
\n\n| Previous Name | \nPatient.name | \n
\n\n| Suffix | \nPatient.name.suffix | \n
\n\n| US Core Birth Sex Extension | \nPatient.extension.BirthSex | \n
\n\n| Date of Birth | \nPatient.birthDate | \n
\n\n| US Core Race Extension | \nPatient.extension.race | \n
\n\n| US Core Extension Ethnicity | \nPatient.extension.ethnicity | \n
\n\n| Preferred Language | \nPatient.communication | \n
\n\n| Address | \nPatient.address | \n
\n\n| Phone Number | \nPatient.telecom | \n
\n\n
\n
This resource conforms to USCDI profile for Encounter - refer to US Core Encounter Profile. Encounter resource response can be requested in JSON or XML format as per FHIR standard R4 version Encounter - FHIR v4.0.1 (hl7.org) supports the following data for Encounter.
\n\n\n\n| USCore Data Element | \nFHIR Resource Data | \n
\n\n\n\n| status | \nEncounter.status | \n
\n\n| classification | \nEncounter.class | \n
\n\n| type | \nEncounter.type | \n
\n\n| patient | \nEncounter.subject | \n
\n\n
\n
This resource conforms to USCDI profile for DiagnosticReport - refer to US Core DiagnosticReport Profile. DiagnosticReport response can be requested in JSON or XML format as per FHIR standard R4 version DiagnosticReport- FHIR v4.0.1 (hl7.org) supports the following data elements documented DiagnosticReport as Laboratory.
\n\n\n\n| USCore Data Element | \nFHIR Resource Data | \n
\n\n\n\n| status | \nDiagnosticReport.status (like registered | \n
\n\n| category | \nDiagnosticReport.category | \n
\n\n| code | \nDiagnosticReport.code | \n
\n\n| patient | \nDiagnosticReport.subject | \n
\n\n| time | \nDiagnosticReport.issued | \n
\n\n| reported time | \nDiagnosticReport.effective | \n
\n\n
\n
This resource conforms to USCDI profile for DocumentReference - refer to US Core DocumentReference Profile. DocumentReference response can be requested in JSON or XML format as per FHIR standard R4 version DocumentReference - FHIR v4.0.1 (hl7.org) supports the following data elements:
\n\n\n\n| USCore Data Element | \nFHIR Resource Data | \n
\n\n\n\n| status | \ndocumentReference.status | \n
\n\n| document category | \ndocumentReference.category | \n
\n\n| code | \ndocumentReference.type | \n
\n\n| patient | \ndocumentReference.subject | \n
\n\n| MIME type | \ndocumentReference.content.Typeformat | \n
\n\n| document URL | \ndocumentReference.content.attachment | \n
\n\n
\n
\n\n\n| Document Type | \nLOINC Code | \n
\n\n\n\n| Consultation Note | \n11488-4 | \n
\n\n| Discharge Summary | \n18842-5 | \n
\n\n| History & Physical | \n34117-2 | \n
\n\n| Progress Note | \n11506-3 | \n
\n\n
\n
This resource conforms to USCDI profile for DiagnosticReport - refer to US Core DiagnosticReport Note Profile. DiagnosticReport response can be requested in JSON or XML format as per FHIR standard R4 version DiagnosticReport- FHIR v4.0.1 (hl7.org) supports the following data elements documented DiagnosticReport as Laboratory.
\n\n\n\n| USCore Data Element | \nFHIR Resource Data | \n
\n\n\n\n| status | \nDiagnosticReport.status | \n
\n\n| category | \nDiagnosticReport.category | \n
\n\n| code | \nDiagnosticReport.code | \n
\n\n| patient | \nDiagnosticReport.subject | \n
\n\n| report date and time | \nDiagnosticReport.effective | \n
\n\n
\n
This resource conforms to USCDI profile for Organization - refer to USCore Organization Profile. Organization response can be requested in JSON or XML format as per FHIR standard R4 version Organization - FHIR v4.0.1 (hl7.org) supports the following data elements:
\n\n\n\n| USCore Data Element | \nFHIR Resource Data | \n
\n\n\n\n| status | \nOrganization.status | \n
\n\n| name | \nOrganization.name | \n
\n\n
\n