POST api/PatientActivation

Retrieve the FHIR Activation Info for an existing Patient or create a new Patient and retrieve their FHIR Activation Info.

Request Information

URI Parameters

None.

Body Parameters

Collection of ActivateInfo

Name	Type	Additional information
RepositoryDetails	RepositoryDetails	None.
OnboardingInstructions	ActivateInstructions	None.
Message	string	None.
ExternalPracticeId	string	Required
PatientDetails	PatientDetails	Required
API_ID	string	None.
isPatientAccountActive	boolean	None.
IsFHIRAPIActive	boolean	None.
PatientFHIRActivationURL	string	None.
ActivationKey	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "RepositoryDetails": {
      "ConnectionString": "sample string 1",
      "ConnectionStringCqmSolution": "sample string 2",
      "ConnectionStringConnectEhr": "sample string 3",
      "RepositoryTypeID": "sample string 4",
      "StoredProcedureAmbulatoryIndividual": "sample string 5",
      "StoredProcedureAmmbulatoryGroup": "sample string 6",
      "StoredProcedureGetVendorDataEH": "sample string 7",
      "StoredProcedureGetLastUpdatedDatetime": "sample string 8"
    },
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true
    },
    "Message": "sample string 1",
    "ExternalPracticeId": "sample string 2",
    "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"
    },
    "API_ID": "sample string 3",
    "isPatientAccountActive": true,
    "IsFHIRAPIActive": true,
    "PatientFHIRActivationURL": "sample string 6",
    "ActivationKey": "sample string 7"
  },
  {
    "RepositoryDetails": {
      "ConnectionString": "sample string 1",
      "ConnectionStringCqmSolution": "sample string 2",
      "ConnectionStringConnectEhr": "sample string 3",
      "RepositoryTypeID": "sample string 4",
      "StoredProcedureAmbulatoryIndividual": "sample string 5",
      "StoredProcedureAmmbulatoryGroup": "sample string 6",
      "StoredProcedureGetVendorDataEH": "sample string 7",
      "StoredProcedureGetLastUpdatedDatetime": "sample string 8"
    },
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true
    },
    "Message": "sample string 1",
    "ExternalPracticeId": "sample string 2",
    "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"
    },
    "API_ID": "sample string 3",
    "isPatientAccountActive": true,
    "IsFHIRAPIActive": true,
    "PatientFHIRActivationURL": "sample string 6",
    "ActivationKey": "sample string 7"
  }
]

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>
    <API_ID>sample string 3</API_ID>
    <ActivationKey>sample string 7</ActivationKey>
    <ExternalPracticeId>sample string 2</ExternalPracticeId>
    <IsFHIRAPIActive>true</IsFHIRAPIActive>
    <Message>sample string 1</Message>
    <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>
    <PatientFHIRActivationURL>sample string 6</PatientFHIRActivationURL>
    <RepositoryDetails>
      <ConnectionString>sample string 1</ConnectionString>
      <ConnectionStringConnectEhr>sample string 3</ConnectionStringConnectEhr>
      <ConnectionStringCqmSolution>sample string 2</ConnectionStringCqmSolution>
      <RepositoryTypeID>sample string 4</RepositoryTypeID>
      <StoredProcedureAmbulatoryIndividual>sample string 5</StoredProcedureAmbulatoryIndividual>
      <StoredProcedureAmmbulatoryGroup>sample string 6</StoredProcedureAmmbulatoryGroup>
      <StoredProcedureGetLastUpdatedDatetime>sample string 8</StoredProcedureGetLastUpdatedDatetime>
      <StoredProcedureGetVendorDataEH>sample string 7</StoredProcedureGetVendorDataEH>
    </RepositoryDetails>
    <isPatientAccountActive>true</isPatientAccountActive>
  </ActivateInfo>
  <ActivateInfo>
    <API_ID>sample string 3</API_ID>
    <ActivationKey>sample string 7</ActivationKey>
    <ExternalPracticeId>sample string 2</ExternalPracticeId>
    <IsFHIRAPIActive>true</IsFHIRAPIActive>
    <Message>sample string 1</Message>
    <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>
    <PatientFHIRActivationURL>sample string 6</PatientFHIRActivationURL>
    <RepositoryDetails>
      <ConnectionString>sample string 1</ConnectionString>
      <ConnectionStringConnectEhr>sample string 3</ConnectionStringConnectEhr>
      <ConnectionStringCqmSolution>sample string 2</ConnectionStringCqmSolution>
      <RepositoryTypeID>sample string 4</RepositoryTypeID>
      <StoredProcedureAmbulatoryIndividual>sample string 5</StoredProcedureAmbulatoryIndividual>
      <StoredProcedureAmmbulatoryGroup>sample string 6</StoredProcedureAmmbulatoryGroup>
      <StoredProcedureGetLastUpdatedDatetime>sample string 8</StoredProcedureGetLastUpdatedDatetime>
      <StoredProcedureGetVendorDataEH>sample string 7</StoredProcedureGetVendorDataEH>
    </RepositoryDetails>
    <isPatientAccountActive>true</isPatientAccountActive>
  </ActivateInfo>
</ArrayOfActivateInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of OnboardResultActivate

Name	Type	Additional information
Product	string	None.
Success	boolean	None.
Message	string	None.
ExternalPracticeID	string	None.
PatientID	string	None.
APIID	string	None.
isPatientAccountActive	boolean	None.
isFHIRAPIActive	boolean	None.
PatientFHIRActivationURL	string	None.
ActivationKey	string	None.

Response Formats

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

Sample:

Sample not available.