POST api/PatientActivation

Activates a new Patient. or Update exsisting patient

Request Information

URI Parameters

None.

Body Parameters

Collection of ActivateInfo

Name	Description	Type	Additional information
OnboardingInstructions	Gets or sets the onboarding instructions.	ActivateInstructions	None.
ExternalPracticeId	Gets or sets the external practice identifier.	string	Required
PatientDetails	Gets or sets the details of the patient.	PatientDetails	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true
    },
    "ExternalPracticeId": "sample string 1",
    "PatientDetails": {
      "PatientID": "sample string 1",
      "NameLast": "sample string 2",
      "NameFirst": "sample string 3",
      "DateOfBirth": "sample string 4",
      "Gender": "sample string 5",
      "Address": {
        "Street1": "sample string 1",
        "Street2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "Zip": "sample string 5",
        "Country": "sample string 6",
        "Phone": "sample string 7",
        "Fax": "sample string 8"
      },
      "Race": "sample string 6"
    }
  },
  {
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true
    },
    "ExternalPracticeId": "sample string 1",
    "PatientDetails": {
      "PatientID": "sample string 1",
      "NameLast": "sample string 2",
      "NameFirst": "sample string 3",
      "DateOfBirth": "sample string 4",
      "Gender": "sample string 5",
      "Address": {
        "Street1": "sample string 1",
        "Street2": "sample string 2",
        "City": "sample string 3",
        "State": "sample string 4",
        "Zip": "sample string 5",
        "Country": "sample string 6",
        "Phone": "sample string 7",
        "Fax": "sample string 8"
      },
      "Race": "sample string 6"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfActivateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
  <ActivateInfo>
    <ExternalPracticeId>sample string 1</ExternalPracticeId>
    <OnboardingInstructions xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.ActivateInfo">
      <d3p1:OnboardToConnectEHR>true</d3p1:OnboardToConnectEHR>
      <d3p1:OnboardToCqmSolution>true</d3p1:OnboardToCqmSolution>
    </OnboardingInstructions>
    <PatientDetails>
      <Address>
        <City>sample string 3</City>
        <Country>sample string 6</Country>
        <Fax>sample string 8</Fax>
        <Phone>sample string 7</Phone>
        <State>sample string 4</State>
        <Street1>sample string 1</Street1>
        <Street2>sample string 2</Street2>
        <Zip>sample string 5</Zip>
      </Address>
      <DateOfBirth>sample string 4</DateOfBirth>
      <Gender>sample string 5</Gender>
      <NameFirst>sample string 3</NameFirst>
      <NameLast>sample string 2</NameLast>
      <PatientID>sample string 1</PatientID>
      <Race>sample string 6</Race>
    </PatientDetails>
  </ActivateInfo>
  <ActivateInfo>
    <ExternalPracticeId>sample string 1</ExternalPracticeId>
    <OnboardingInstructions xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.ActivateInfo">
      <d3p1:OnboardToConnectEHR>true</d3p1:OnboardToConnectEHR>
      <d3p1:OnboardToCqmSolution>true</d3p1:OnboardToCqmSolution>
    </OnboardingInstructions>
    <PatientDetails>
      <Address>
        <City>sample string 3</City>
        <Country>sample string 6</Country>
        <Fax>sample string 8</Fax>
        <Phone>sample string 7</Phone>
        <State>sample string 4</State>
        <Street1>sample string 1</Street1>
        <Street2>sample string 2</Street2>
        <Zip>sample string 5</Zip>
      </Address>
      <DateOfBirth>sample string 4</DateOfBirth>
      <Gender>sample string 5</Gender>
      <NameFirst>sample string 3</NameFirst>
      <NameLast>sample string 2</NameLast>
      <PatientID>sample string 1</PatientID>
      <Race>sample string 6</Race>
    </PatientDetails>
  </ActivateInfo>
</ArrayOfActivateInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of OnboardResultActivate

Name	Description	Type	Additional information
Product	Gets or sets the product associated with the onboarding result.	string	None.
Success	Gets or sets a value indicating whether the onboarding process was successful.	boolean	None.
Message	Gets or sets the message associated with the onboarding result.	string	None.
ExternalPracticeID	Gets or sets the external practice identifier.	string	None.
PatientID	Gets or sets the patient identifier.	string	None.
APIID	Gets or sets the API identifier.	string	None.
isPatientAccountActive	Gets or sets a value indicating whether the patient's account is active.	boolean	None.
isFHIRAPIActive	Gets or sets a value indicating whether the FHIR API is active.	boolean	None.
PatientFHIRActivationURL	Gets or sets the URL for the patient's FHIR activation.	string	None.
ActivationKey	Gets or sets the activation key.	string	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.