POST api/User

Creates a new User. If configured, updates an existing User (located via ExternalId and PracticeID).

Request Information

URI Parameters

None.

Body Parameters

Collection of User

Name	Description	Type	Additional information
ExternalId	External User ID	string	Required Max length: 100
Username	Username	string	Required Max length: 100
FirstName	First Name	string	Required Max length: 50
LastName	Last Name	string	Required Max length: 50
EmailAddress	Email Address	string	Required Max length: 200
PracticeID	External Practice ID	string	Required Max length: 100
SecondaryPracticeIDs	[CEHR] External Practice IDs for additional practices to which the clinician belongs.	Collection of string	None.
Password	Password. Optional. Includes 3 of the 4 following character types: Upper case letter (A-Z), lower case letter (a-z), number (0-9), and special character. If not populated, must be set by an administrator before the user can login.	string	Max length: 128 Min length: 8
IsActive	User is active. Defaults to True. If the user exists, they will be deactivated. No other updates will be performed.	boolean	None.
Role	Role - Clinician, PracticeAdmin, ReportCordinator, or EHRAdmin (Entity Admin).	string	Required
UserIdentifiers	User identifiers (such as NPI).	UserIdentifiers	None.
Address	[CEHR] Required for Direct Onboarding. Street Address & Phone Numbers.	Address	None.
CqmSolutionProgramSettings	[CQM] Submission Program settings	ProgramSettings	None.
CqmSolutionPersonalization	[CQM] User-specific customizations	Personalization	None.
DirectSettings	[CEHR] Direct account settings	DirectUserSettings	None.
OnboardingInstructions	Provides processing instructions to the Onboarding API for this item	UserInstructions	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ExternalId": "sample string 1",
    "Username": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "EmailAddress": "sample string 5",
    "PracticeID": "sample string 6",
    "SecondaryPracticeIDs": [
      "sample string 1",
      "sample string 2"
    ],
    "Password": "sample string 7",
    "IsActive": true,
    "Role": "sample string 8",
    "UserIdentifiers": {
      "NPI": "sample string 1"
    },
    "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"
    },
    "CqmSolutionProgramSettings": {
      "QRDA3": true,
      "MIPS_Individual": true,
      "MIPS_Group": true,
      "HQR_PI": true,
      "HQR_PI_UniqueId": true,
      "HQR_IQR": true,
      "HQR_IQR_UniqueId": true,
      "HQR_PI_IQR": true,
      "HQR_PI_IQR_UniqueId": true,
      "QPP_Individual": true,
      "QPP_Group": true,
      "PQRS_Individual": true,
      "PQRS_Group": true,
      "CCBHC": true,
      "Medicaid": true,
      "IsPcf": true
    },
    "CqmSolutionPersonalization": {
      "PreSelectedMeasures": "sample string 1",
      "PreSelectedMeasureType": "sample string 2",
      "PreSelectedMeasureBundle": "sample string 3",
      "CardOrder": "sample string 4"
    },
    "DirectSettings": {
      "DirectUsername": "sample string 1",
      "DirectPassword": "sample string 2"
    },
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true,
      "ShouldOnboardDirect": true
    }
  },
  {
    "ExternalId": "sample string 1",
    "Username": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "EmailAddress": "sample string 5",
    "PracticeID": "sample string 6",
    "SecondaryPracticeIDs": [
      "sample string 1",
      "sample string 2"
    ],
    "Password": "sample string 7",
    "IsActive": true,
    "Role": "sample string 8",
    "UserIdentifiers": {
      "NPI": "sample string 1"
    },
    "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"
    },
    "CqmSolutionProgramSettings": {
      "QRDA3": true,
      "MIPS_Individual": true,
      "MIPS_Group": true,
      "HQR_PI": true,
      "HQR_PI_UniqueId": true,
      "HQR_IQR": true,
      "HQR_IQR_UniqueId": true,
      "HQR_PI_IQR": true,
      "HQR_PI_IQR_UniqueId": true,
      "QPP_Individual": true,
      "QPP_Group": true,
      "PQRS_Individual": true,
      "PQRS_Group": true,
      "CCBHC": true,
      "Medicaid": true,
      "IsPcf": true
    },
    "CqmSolutionPersonalization": {
      "PreSelectedMeasures": "sample string 1",
      "PreSelectedMeasureType": "sample string 2",
      "PreSelectedMeasureBundle": "sample string 3",
      "CardOrder": "sample string 4"
    },
    "DirectSettings": {
      "DirectUsername": "sample string 1",
      "DirectPassword": "sample string 2"
    },
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true,
      "ShouldOnboardDirect": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
  <User>
    <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>
    <CqmSolutionPersonalization>
      <CardOrder>sample string 4</CardOrder>
      <PreSelectedMeasureBundle>sample string 3</PreSelectedMeasureBundle>
      <PreSelectedMeasureType>sample string 2</PreSelectedMeasureType>
      <PreSelectedMeasures>sample string 1</PreSelectedMeasures>
    </CqmSolutionPersonalization>
    <CqmSolutionProgramSettings>
      <CCBHC>true</CCBHC>
      <HQR_IQR>true</HQR_IQR>
      <HQR_IQR_UniqueId>true</HQR_IQR_UniqueId>
      <HQR_PI>true</HQR_PI>
      <HQR_PI_IQR>true</HQR_PI_IQR>
      <HQR_PI_IQR_UniqueId>true</HQR_PI_IQR_UniqueId>
      <HQR_PI_UniqueId>true</HQR_PI_UniqueId>
      <IsPcf>true</IsPcf>
      <MIPS_Group>true</MIPS_Group>
      <MIPS_Individual>true</MIPS_Individual>
      <Medicaid>true</Medicaid>
      <PQRS_Group>true</PQRS_Group>
      <PQRS_Individual>true</PQRS_Individual>
      <QPP_Group>true</QPP_Group>
      <QPP_Individual>true</QPP_Individual>
      <QRDA3>true</QRDA3>
    </CqmSolutionProgramSettings>
    <DirectSettings>
      <DirectPassword>sample string 2</DirectPassword>
      <DirectUsername>sample string 1</DirectUsername>
    </DirectSettings>
    <EmailAddress>sample string 5</EmailAddress>
    <ExternalId>sample string 1</ExternalId>
    <FirstName>sample string 3</FirstName>
    <IsActive>true</IsActive>
    <LastName>sample string 4</LastName>
    <OnboardingInstructions>
      <OnboardToConnectEHR>true</OnboardToConnectEHR>
      <OnboardToCqmSolution>true</OnboardToCqmSolution>
      <ShouldOnboardDirect>true</ShouldOnboardDirect>
    </OnboardingInstructions>
    <Password>sample string 7</Password>
    <PracticeID>sample string 6</PracticeID>
    <Role>sample string 8</Role>
    <SecondaryPracticeIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SecondaryPracticeIDs>
    <UserIdentifiers>
      <NPI>sample string 1</NPI>
    </UserIdentifiers>
    <Username>sample string 2</Username>
  </User>
  <User>
    <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>
    <CqmSolutionPersonalization>
      <CardOrder>sample string 4</CardOrder>
      <PreSelectedMeasureBundle>sample string 3</PreSelectedMeasureBundle>
      <PreSelectedMeasureType>sample string 2</PreSelectedMeasureType>
      <PreSelectedMeasures>sample string 1</PreSelectedMeasures>
    </CqmSolutionPersonalization>
    <CqmSolutionProgramSettings>
      <CCBHC>true</CCBHC>
      <HQR_IQR>true</HQR_IQR>
      <HQR_IQR_UniqueId>true</HQR_IQR_UniqueId>
      <HQR_PI>true</HQR_PI>
      <HQR_PI_IQR>true</HQR_PI_IQR>
      <HQR_PI_IQR_UniqueId>true</HQR_PI_IQR_UniqueId>
      <HQR_PI_UniqueId>true</HQR_PI_UniqueId>
      <IsPcf>true</IsPcf>
      <MIPS_Group>true</MIPS_Group>
      <MIPS_Individual>true</MIPS_Individual>
      <Medicaid>true</Medicaid>
      <PQRS_Group>true</PQRS_Group>
      <PQRS_Individual>true</PQRS_Individual>
      <QPP_Group>true</QPP_Group>
      <QPP_Individual>true</QPP_Individual>
      <QRDA3>true</QRDA3>
    </CqmSolutionProgramSettings>
    <DirectSettings>
      <DirectPassword>sample string 2</DirectPassword>
      <DirectUsername>sample string 1</DirectUsername>
    </DirectSettings>
    <EmailAddress>sample string 5</EmailAddress>
    <ExternalId>sample string 1</ExternalId>
    <FirstName>sample string 3</FirstName>
    <IsActive>true</IsActive>
    <LastName>sample string 4</LastName>
    <OnboardingInstructions>
      <OnboardToConnectEHR>true</OnboardToConnectEHR>
      <OnboardToCqmSolution>true</OnboardToCqmSolution>
      <ShouldOnboardDirect>true</ShouldOnboardDirect>
    </OnboardingInstructions>
    <Password>sample string 7</Password>
    <PracticeID>sample string 6</PracticeID>
    <Role>sample string 8</Role>
    <SecondaryPracticeIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </SecondaryPracticeIDs>
    <UserIdentifiers>
      <NPI>sample string 1</NPI>
    </UserIdentifiers>
    <Username>sample string 2</Username>
  </User>
</ArrayOfUser>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of OnboardResult

Name	Description	Type	Additional information
Success	Indicates successful insert/update	boolean	None.
Message	Error message	string	None.
InReferenceToExternalId	External ID of the Practice or User	string	None.
Product	CQMsolution or ConnectEHR	string	None.
FhirR4Endpoint	FHIR R4 Endpoint	string	None.
FhirR4EndpointResource	FHIR R4 Resource Endpoint	string	None.
FhirR4OrganizationResource	FHIR R4 Organization Resource Endpoint	string	None.

Response Formats

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

Sample:

Sample not available.