MDCare API Version 5.0

Terms and Conditions of Use

Details of terms and conditions for using MDCare EMR/PMS API version 5.0.

Documentation of MDCare EMR/PMS API is made available to developers for development and testing. The documentation is provided to developers as-is with no other warranties expressed or implied. Developers may use the documentation with adherence to the below terms and conditions:
MDCare EMR/PMS portal has the most up-to-date documentation. Developers may keep copies of the documentation; however, they may not be distributed without prior permission.

MDCare EMR/PMS owns the Documentation, as well as any improvements to or derivatives of the Documentation, such as enhancements to the testing tools or documentation. Any suggested improvements of the Documentation may become part of the Documentation without any obligation or notice to the submitter.

Developers are responsible for the products developed and how the products connect to the other software. Developers are also responsible for complying with all applicable laws, including not infringing on MDCare’s or others’ intellectual property rights. Some interfaces listed on the MDCare EMR/PMS portal may require a customer to license additional functionality or build additional workflows, so developers are requested to work closely with MDCare EMR/PMS Development team and mutual customers in order to avoid unfavorable results.

Please contact support@vinfonet.com to obtain permissions.

Application Access - WEB API: Below API methods publicly accessible with trusted authentication to identify a patient and/or access Information related to a specific patient with in a secure session.

Token

  • Method Name: "Token"
  • Description: To Get Patient's Token Based on given input data. Token would expire after session Time Out.
  • Parameters:
    1. First Name (Patient’s First name)
    2. Last Name (Patient’s Last name)
    3. Secret key (Issued to Patient at the time of registration)
    4. Mrno (Patient’s Medical Record Number)
    5. Username (Requester Name)
    6. User Email (Requester email)
    7. User Phone (Requester Phone)
  • Required Parameters: Username, User Email, User Phone, Secret Key and either Mrno or First & Last name of patient for capturing requester details.
  • Success Response: Returns a String in XML format, containing a random value called "token"
<user>
<token>xnChEfP11EhWAOqF9srPRZX7lcevrOCkTURDYXJlNzQ0ODI=</token>
<ExpireTimeInMinutes>15</ExpireTimeInMinutes>
</user>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid Credentials
    2. Unknown Error
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/token?UserName=abcd&UserEmail=abc@xyz.com&UserPhone=111-111-1111&secretkey=N^VK8H987098MDCare&Mrno=74482

Patient Name

  • Method Name: "PatientName"
  • Description: To Get Patient's Name
  • Parameters: Token.
  • Required Parameters: Token : Alphanumeric value which is used to identify patient.
  • Success Response: Returns a String in XML format, containing name of the patient.
<PatientName>
<prefix />
<given>Alice</given>
<family>NewmanSample</family>
<suffix />
</PatientName>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/PatientName? Token=xxxxxxxxxxxxxxxxxxxxxxxxx

Sex

  • Method Name: "Gender"
  • Description: To Get Patient's Gender
  • Parameters: Token
  • Required Parameters: Token: Alphanumeric value which is used to identify patient.
  • Success Response: Returns a String in XML format, containing Gender of the patient.
<PatientInfo>
<Gender>Female</Gender>
</PatientInfo>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token.
    2. Token session Expired
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/Gender? Token=xxxxxxxxxxxxxxxxxx

Date of birth

  • Method Name: "DateOfBirth"
  • Description: To Get Patient's DOB
  • Parameters: Token
  • Required: Token: Alphanumeric value which is used to identify patient.
  • Success Response: Returns a String in XML format, containing DOB of the patient.
<PatientInfo>
<DateOfBirth>19880121</DateOfBirth>
</PatientInfo>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/DateOfBirth?Token=Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Race

  • Method Name: "Race"
  • Description: To Get Patient's Race(s)
  • Parameters: Token
  • Required Parameters: Token: Alphanumeric value which is used to identify patient.
  • Success Response: Returns a String in XML format, containing Race(s) of the patient.
<PatientInfo>
<RACE>
<DisplayName>White</DisplayName>
<Code>2106-3</Code>
<Code_SystemName>CDC-RACE</Code_SystemName>
</RACE>
</PatientInfo>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Race?Token=Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • Notes: It is possible to document more than one race, if in such a case, XML string should carry all the races documented in the s/w.

Ethnicity

  • Method Name: "Ethnicity"
  • Description: To Get Patient's Ethnicity
  • Parameters: Token
  • Required Parameters: Token: Alphanumeric value which is used to identify patient.
  • Success Response: Returns a String in XML format, containing Ethnicity of the patient.
<PatientInfo>
<Ethnicity>
<DisplayName>Hispanic or Latino</DisplayName>
<Code>2135-2</Code>
<Code_SystemName>CDC -Ethnicity</Code_SystemName>
</Ethnicity>
</PatientInfo>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Ethnicity?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Preferred Language

  • Method Name: "Preferred_Language"
  • Description: To Get Patient's Preferred-Language(s)
  • Parameters: Token
  • Required: Token: alphanumerical value which used to identify patient
  • Success Response: Returns a String in XML format, containing Preferred-Language(s) of the patient.
<PatientInfo>
<PatientInfo>
<languages>
<DisplayName>English</DisplayName>
<Code>en</Code>
<Code_systemName>LanguageAbilityMode</Code_systemName>
</languages> 
<PatientInfo>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Preferred_Language?Token=Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate =06/22/2015
  • Notes: It is possible to document more than one preferred language, if in such a case, XML string should carry all the items documented in the s/w.

Smoking Status

  • Method Name: "Smoking_Status"
  • Description: To Get Patient's Smoking-Status
  • Parameters: Token
    1. FromDate - DateTime
    2. ToDate - DateTime
  • Required : Token: Alphanumeric value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Smoking Status of the patient
<SocialHistory>
<SmokingStatus>
<SNOMED_CT>449868002</SNOMED_CT>
<Smoking_Status>Current every day smoker</Smoking_Status>
<Start_Date>20150622</Start_Date>
</SmokingStatus>
</SocialHistory>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No data found
    4. unknown error
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Smoking_Status?Token=xxxxxxxxxxxxxxxxxxxxxxx&FromDate=08/01/2017&ToDate=08/31/2017

Problems

  • Method Name: "Problems"
  • Description: To Get Patient's Problems List of Visits that occurred between or on given date range or date .
  • Parameters:
    1. Token
    2. FromDate – DateTime
    3. ToDate - DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Problems of the patient
<Problems>
<problem>
<Problem>Hypothyroidism, unspecified</Problem>
<problemcode>83986005</problemcode>
<Date>20061231</Date>
<EndDate></EndDate>
<Status>Active</Status>
<CodeSystemName>SNOMED-CT</CodeSystemName>
</problem>
<problem>
<Problem>Obesity, unspecified</Problem>
<problemcode>238131007</problemcode>
<Date>20061231</Date>
<EndDate>20070601</EndDate>
<Status>completed</Status>
<CodeSystemName>SNOMED-CT</CodeSystemName>
</problem>
</Problems>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token.
    2. Token session Expired.
    3. No Data Found
    4. Unknown Error
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Problems?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=&ToDate=08/09/2017

Medications

  • Method Name: "Medications"
  • Description: To Get Patient's Medications
  • Parameters:
    1. Token
    2. FromDate – DateTime
    3. ToDate - DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Medications of the patient
<Medications>
<Medication>
<Medication_Name>Tylenol Extra Strength 500 MG Oral Tablet</Medication_Name>
<Rxnormcode>209459</Rxnormcode>
<Composition>ACETAMINOPHEN</Composition>
<StartDate>20150622</StartDate>
<EndDate>20150701</EndDate>
<Quantity>10</Quantity>
<Dose>1</Dose>
<DoseName>Unit</DoseName>
<InstructionText> for 10 days</InstructionText>
<RouteValue>ORALLY</RouteValue>
<Frequency>as needed</Frequency>
<Status>Inactive</Status>
<Statuscode>code="73425007"</Statuscode>
<Order_Quantity>10</Order_Quantity>
<Performer_Prefix>Dr.</Performer_Prefix>
<performer_GivenName>Davis Albert</performer_GivenName>
<performer_FamilyName></performer_FamilyName>
</Medication>
<Medication>
<Medication_Name>cefTRIAXone 100 MG/ML Injectable Solution</Medication_Name>
<Rxnormcode>309090</Rxnormcode>
<Composition>CEFTRIAXONE</Composition>
<StartDate>20150622</StartDate>
<EndDate>20150630</EndDate>
<Quantity>1</Quantity>
<Dose>1</Dose>
<DoseName>Unit</DoseName>
<InstructionText> for 9 days</InstructionText>
<RouteValue>INTRAVENOUSLY</RouteValue>
<Frequency>twice a day</Frequency>
<Status>Inactive</Status>
<Statuscode>code="73425007"</Statuscode>
<Order_Quantity>1</Order_Quantity>
<Performer_Prefix>Dr.</Performer_Prefix>
<performer_GivenName>Davis Albert</performer_GivenName>
<performer_FamilyName></performer_FamilyName>
</Medication>
<Medication>
<Medication_Name>Aranesp 500 MCG in 1 ML Prefilled Syringe</Medication_Name>
<Rxnormcode>731241</Rxnormcode>
<Composition>DARBEPOETIN ALFA</Composition>
<StartDate>20150622</StartDate>
<EndDate></EndDate>
<Quantity>0</Quantity>
<Dose>1</Dose>
<DoseName>Unit</DoseName>
<InstructionText> for days</InstructionText>
<RouteValue>INTRAVENOUSLY</RouteValue>
<Frequency>once a week</Frequency>
<Status>Active</Status>
<Statuscode>code="55561003"</Statuscode>
<Order_Quantity>0</Order_Quantity>
<Performer_Prefix>Dr.</Performer_Prefix>
<performer_GivenName>Davis Albert</performer_GivenName>
<performer_FamilyName></performer_FamilyName>
</Medication>
</Medications>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/Medications? Token=xxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/06/2017&ToDate=06/22/2017

Medication Allergies

  • Method Name: "Medication_Allergies"
  • Description: To Get Patient's Medication-Allergies
  • Parameters:
    1. Token
    2. FromDate – DateTime
    3. ToDate - DateTime
  • Required: Token: Alphanumeric value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Medication Allergies of the patient
<ALL>
<Allergies>
<allergy>PENICILLIN G</allergy>
<NDCcode>720001</NDCcode>
<RxNorm>7980</RxNorm>
<AllergyRecordedDate>20170915</AllergyRecordedDate>
<TimingInformation>19800510</TimingInformation>
<Status>Active</Status>
<SeverityName>Moderate</SeverityName>
<Reaction>
<Reaction_Name>Hives</Reaction_Name>
<Code>247472004</Code>
<CodeSystemName>SNOMED-CT</CodeSystemName>
<Reaction_Severity>Moderate</Reaction_Severity>
</Reaction>
</Allergies>
<Allergies>
<allergy>AMPICILLIN</allergy>
<NDCcode>720101</NDCcode>
<RxNorm>733</RxNorm>
<AllergyRecordedDate>20170915</AllergyRecordedDate>
<TimingInformation>19800510</TimingInformation>
<Status>Active</Status>
<StatusCode></StatusCode>
<SeverityName>Moderate</SeverityName>
<SeverityCode>6736007</SeverityCode>
<Reaction>
<Reaction_Name>Hives</Reaction_Name>
<Code>247472004</Code>
<CodeSystemName>SNOMED-CT</CodeSystemName>
<Reaction_Severity>Moderate</Reaction_Severity>
</Reaction>
</Allergies>
</ALL>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Medication_Allergies?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/06/2017&ToDate=06/22/2017

Laboratory Tests

  • Method Name: "LabTest"
  • Description: To Get Patient's Laboratory Tests
  • Parameters :
    1. Token
    2. FromDate – DateTime
    3. ToDate - DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns  a String in XML format , containing Laboratory Tests of the patient
<Labs>
<LabTest>
<TestName>EKG</TestName>
<LOINCCODE>34534-8</LOINCCODE>
<CPTCode>93000</CPTCode>
<Date>20150623</Date>
<Performer_GivenName>Davis Albert</Performer_GivenName>
<Performer_FamilyName></Performer_FamilyName>
<Performer_Streetname>2472, Rocky Place </Performer_Streetname>
<Performer_City>Beaverton</Performer_City>
<Performer_State>OR</Performer_State>
<Performer_Country>USA</Performer_Country>
<Performer_PostalCode>97006</Performer_PostalCode>
</LabTest>
<LabTest>
<TestName>Urinanalysis macro (dipstick) panel</TestName>
<LOINCCODE>24357-6</LOINCCODE>
<CPTCode>81000</CPTCode>
<Date>20150622</Date>
<Performer_GivenName>Davis Albert</Performer_GivenName>
<Performer_FamilyName></Performer_FamilyName>
<Performer_Streetname>2472, Rocky Place </Performer_Streetname>
<Performer_City>Beaverton</Performer_City>
<Performer_State>OR</Performer_State>
<Performer_Country>USA</Performer_Country>
<Performer_PostalCode>97006</Performer_PostalCode>
</LabTest>
<LabTest>
<TestName>Urinanalysis macro (dipstick) panel</TestName>
<LOINCCODE>24357-6</LOINCCODE>
<CPTCode>81000</CPTCode>
<Date>20150629</Date>
<Performer_GivenName>Davis Albert</Performer_GivenName>
<Performer_FamilyName></Performer_FamilyName>
<Performer_Streetname>2472, Rocky Place </Performer_Streetname>
<Performer_City>Beaverton</Performer_City>
<Performer_State>OR</Performer_State>
<Performer_Country>USA</Performer_Country>
<Performer_PostalCode>97006</Performer_PostalCode>
</LabTest>
</Labs>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/LabTest?Token= xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=30/06/2017

Laboratory Value(s)/ Result(s)

  • Method Name: "Laboratory_Result"
  • Description: To Get Patient's Laboratory-Values-Results
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Laboratory-Value(s)-Result(s) of the patient
<LabResults>
<LabTest>
<LOINC_Code>24357-6</LOINC_Code>
<Test>Urinanalysis macro (dipstick) pane</Test>
<TestDate>20150622</TestDate>
<TestResult>
<Loinc_Code>5767-9</Loinc_Code>
<Result>Appearance of Urine</Result>
<Values>1</Values>
<Units>-</Units>
<PerformedDate>20150622</PerformedDate>
<ObservationRange> CLEAR</ObservationRange>
</TestResult>
</LabTest>
<LabTest>
<LOINC_Code>24357-6</LOINC_Code>
<Test>Urinanalysis macro (dipstick) panel</Test>
<TestDate>20150622</TestDate>
<TestResult>
<Loinc_Code>5778-6</Loinc_Code>
<Result>Color of Urine</Result>
<Values>1</Values>
<Units>-</Units>
<PerformedDate>20150622</PerformedDate>
<ObservationRange>Yellow YELLOW</ObservationRange>
</TestResult>
</LabTest>
</LabResults>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Laboratory_Result?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=30/06/2017

Vital Signs

  • Method Name: "Vital_Signs "
  • Description: To Get Patient's Vital-Signs
  • Parameters:
    1. Token
    2. FromDate – DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format , containing Vital Signs of the patient.
<Vital_Sign>
<Vital_Sign>
<Timing_info>2015-06-22T12:26:51.227</Timing_info>
<Height>
<Code>8302-2</Code>
<value>177</value>
<Units>cm</Units>
</Height>
<Weight>
<Code>29463-7</Code>
<Value>88</Value>
<Units>kg</Units>
</Weight>
<Blood_Pressure_Diastolic>
<Code>8462-4</Code>
<Value>88</Value>
<Units>mm[Hg]</Units>
</Blood_Pressure_Diastolic>
<Blood_Pressure-Systolic>
<Code>8480-6</Code>
<Value>145</Value>
<Units> mm[Hg]</Units>
</Blood_Pressure-Systolic>
<Heart_Rate>
<Code>8867-4</Code>
<Value>80</Value>
<Units>/min</Units>
</Heart_Rate>
<O2_Percentage_BldC_Oximetry>
<Code>59408-5</Code>
<Value>95</Value>
<Units>%</Units>
</O2_Percentage_BldC_Oximetry>
<Body_Temperature>
<Code>8310-5</Code>
<Value>38</Value>
<Units> Cel</Units>
</Body_Temperature>
<Respiratory_Rate>
<Code>9279-1</Code>
<value>18</value>
<Units>/min</Units>
</Respiratory_Rate>
<Inhaled_oxygen_concentration>
<Code>3150-0</Code>
<Value>36</Value>
<Units>%</Units>
</Inhaled_oxygen_concentration>
<BMIValue>28.1</BMIValue>
</Vital_Sign>
</Vital_Sign>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/Vital_Signs?Token= Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=30/06/2017

Procedures

  • Method Name: "procedures"
  • Description: To Get Patient's Procedures
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate - DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Procedures of the patient.
<Procedures>
<Procedure>
<proc_name>Nebulizer Therapy</proc_name>
<Date>20150622</Date>
<SNOMEDCT>56251003</SNOMEDCT>
<Snomed_Name>Nebulizer therapy (procedure)</Snomed_Name>
<Status>Completed</Status>
<TargetsiteSnomedCode>82094008</TargetsiteSnomedCode>
<TargetsiteSnomedName>Lower respiratory tract structure (body structure)</TargetsiteSnomedName>
<ServiceDeliveryLocation>Neighborhood Physicians Practice, 2472, Rocky Place, Beaverton, OR 97006</ServiceDeliveryLocation>
<AssignedEntity_street>2472, Rocky Place </AssignedEntity_street>
<AssignedEntity_city>Beaverton</AssignedEntity_city>
<AssignedEntity_state>OR</AssignedEntity_state>
<AssignedEntity_postal>97006</AssignedEntity_postal>
<AssignedEntity_country>USA</AssignedEntity_country>
</Procedure>
</Procedures>
  • Error Response:   Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/procedures?Token=Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=30/06/2017

Care Team Member(s)

  • Method Name: "CareTeamMembers"
  • Description: To Get Patient's Care-Team-Members
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Care-Team-Members of the patient.
<CareTeamMembers>
<CareTeamMember>
<performerstarttime>2015-06-22T12:13:00</performerstarttime>
<performerendtime>2015-06-22T12:13:00</performerendtime>
<Performergiven>Albert</Performergiven>
<PerformerFamily>Davis</PerformerFamily>
<PerformerPrefix></PerformerPrefix>
<PerformerAddress>2472, Rocky Place</PerformerAddress>
<PerformerCity>Beaverton</PerformerCity>
<PerformerState>OR</PerformerState>
<PerformerPostalCode>97006</PerformerPostalCode>
<PerformerCountry>USA</PerformerCountry>
<performerCode>NA</performerCode>
<performertelecom></performertelecom>
</CareTeamMember>
<CareTeamMember>
<performerstarttime>2015-06-22T12:13:00</performerstarttime>
<performerendtime>2015-06-22T12:13:00</performerendtime>
<Performergiven>Tracy</Performergiven>
<PerformerFamily>Davis</PerformerFamily>
<PerformerPrefix></PerformerPrefix>
<PerformerAddress>2472</PerformerAddress>
<PerformerCity>Beaverton</PerformerCity>
<PerformerState>OR</PerformerState>
<PerformerPostalCode>97006</PerformerPostalCode>
<PerformerCountry>USA</PerformerCountry>
<performerCode>NASST</performerCode>
<performertelecom> tel=555-555-1002</performertelecom>
</CareTeamMember>
</CareTeamMembers>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/CareTeamMembers?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=30/06/2017

Immunizations

  • Method Name: "Immunizations"
  • Description: To Get Patient's Immunizations
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Immunizations of the patient.
<Immunizations>
<Immunization>
<Vaccene_Name>DTaP, 5 pertussis antigens</Vaccene_Name>
<Immunization_Code>106</Immunization_Code>
<CodeSystem>CVX</CodeSystem>
<Date>20120104</Date>
<Immunization>DAPTACEL vaccine 0.5 ML Injection</Immunization>
<Route></Route>
<DoseValue></DoseValue>
<Lot_Number>2</Lot_Number>
<Manufacture_Name>Immuno-U.S., Inc.</Manufacture_Name>
<Notes></Notes>
<RefuseReason></RefuseReason>
<Status>Completed</Status>
</Immunization>
<Immunization>
<Vaccene_Name>influenza, intradermal, quadrivalent, preservative free</Vaccene_Name>
<Immunization_Code>166</Immunization_Code>
<CodeSystem>CVX</CodeSystem>
<Date>20150622</Date>
<Immunization>influenza, intradermal, quadrivalent, preservative free</Immunization>
<Route></Route>
<DoseValue></DoseValue>
<Lot_Number></Lot_Number>
<Manufacture_Name />
<Notes>Immunization was not given- patient rejected immunization.</Notes>
<RefuseReason>Patient objection</RefuseReason>
<Status>Cancelled</Status>
</Immunization>
</Immunizations>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/Immunizations?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=06/30/2017

UDI Implants

  • Method Name: "UDIImplants"
  • Description: To Get Patient's UDI-Implants-List
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing UDI-Implants-List of the patient.
<UDI>
<IMPLANTS>
<Procedure>Introduction to cardiac pacemaker system via vein</Procedure>
<Implanted>Viva™ Quad XT CRT-D</Implanted>
<Area>704707009 - Cardiac resynchronization therapy implantable defibrillator (physical object)</Area>
<UDI>(01)00643169007222(17)160128(21)BLC200461H</UDI>
<Model>DTBA1QQ</Model>
<Serial_Number>BLC200461H</Serial_Number>
<Lot_Number></Lot_Number>
<EffectiveDate>20111005</EffectiveDate>
<UDISnomedcode>Code:704707009</UDISnomedcode>
<TargetSiteCodeSnomed>Code:9454009</TargetSiteCodeSnomed>
<AssigningAuthority>FDA</AssigningAuthority>
<performer_street>2472, Rocky Place </performer_street>
<performer_city>Beaverton</performer_city>
<performer_state>OR</performer_state>
<performer_postal>97006</performer_postal>
<performer_country>USA</performer_country>
<performer_phone></performer_phone>
</IMPLANTS>
</UDI>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/UDIImplants?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=01/01/2017&ToDate=09/09/2017

Assessment And Plan Of Treatment

  • Method Name: "Assessment "
  • Description: To Get Patient's plan
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing plan of the patient.
<AssessmentAndPlanOfTreatment>
<Assessments>
<Assessment>
<Date>20150622</Date>
<AssessmentUnstructuredText>Fever: The patient was found to have fever and Dr Davis is suspecting Anemia based on the patient history. So Dr Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health Hospitals if the fever does not subside within a day.</AssessmentUnstructuredText>
</Assessment>
</Assessments>
<PlanOfTreatment>
<FuturePlannedCare>
<Plan>Schedule follow on visit with Neighborhood Physicians Practice on 07/01/2015</Plan>
<Date>20150701</Date>
<Instructions></Instructions>
<Code></Code>
<CodeSystem></CodeSystem>
<Participant_Name>Davis Albert </Participant_Name>
<Participant_Street>2472, Rocky Place </Participant_Street>
<Participant_City>Beaverton</Participant_City>
<Participant_State>OR</Participant_State>
<Participant_Country>USA</Participant_Country>
<Participant_Postal>97006</Participant_Postal>
<Participant_Phone>555-555-1002</Participant_Phone>
</FuturePlannedCare>
</PlanOfTreatment>
</AssessmentAndPlanOfTreatment>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/Assessment?Token= Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=06/30/2017

Goals

  • Method Name: "Goals"
  • Description: To Get Patient's Goals
  • Parameters:
    1. Token
    2. FromDate - DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Goals of the patient.
<Goals>
<Goal>
<Name>Get rid of intermittent fever that is occurring every few weeks</Name>
<Code></Code>
<GoalValue></GoalValue>
<Effective_time></Effective_time>
<Status>Goal not achieved</Status>
<Code_SystemName>SNOMED-CT</Code_SystemName>
</Goal>
<Goal>
<Name>Need to gain more energy to do regular activities</Name>
<Code></Code>
<GoalValue></GoalValue>
<Effective_time></Effective_time>
<Status>Goal not achieved</Status>
<Code_SystemName>SNOMED-CT</Code_SystemName>
</Goal>
</Goals>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0 /api/Goals?Token= Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=06/30/2017

Health Concerns

  • Method Name: "HealthConcerns"
  • Description: To Get Patient's Health-Concerns
  • Parameters:
    1. Token
    2. FromDate – DateTime
    3. ToDate – DateTime
  • Required: Token: alphanumerical value which is used to identify patient.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Returns a String in XML format, containing Health Concerns of the patient
<HealthConcerns>
<HealthConcerns>
<HealthConcern>Keratolytic agent (product) </HealthConcern>
<HealthConcernCode>2871004</HealthConcernCode>
<Code_SystemName>SNOMED-CT</Code_SystemName>
<Status>Active</Status>
<OnSetDate>20170904</OnSetDate>
</HealthConcerns>
</HealthConcerns>
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. No Data Found
    4. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/HealthConcerns?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=06/30/2017

All Data Request

  • Method Name: "AllDataRequest"
  • Description: To Get Patient's Consolidated CDA document in a Zip file
  • Parameters: Token, FromDate, ToDate
  • Required: Token: alphanumerical value which is used to identify patient. and required parameter.
  • Optional: From Date is optional parameter.
    • To Date: is optional parameter
  • Success Response: Downloads a ZIP file which contains Consolidated CDA file.
  • Error Response: Returns any of the below error in case of failed attempt.
    1. Invalid token
    2. Token session Expired
    3. Unknown Error occurred
  • Sample Call: https://apps.mdcare.com/MDcareapiv5.0/api/AllDataRequest?Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&FromDate=06/01/2017&ToDate=06/30/2017


Error Codes: All Methods of API returns an error response along with any of the below codes.

Code Description
301 Invalid ID  or Invalid token.
302 Token session Expired.
303 Invalid Credentials
305 No data found.
307 Unknown error occurred while processing request.
308 Enter a valid date (for example, mm/dd/yyyy).
309 Token Method call requires valid secret key
310 Token Method call requires either  MrNo (or) Last Name ,First name .
311 API Request is missing required parameters - 'Token', 'FromDate'.
312 API Request is missing required parameter - 'FromDate'.
313 API Request is missing required parameter - 'Token'.