POST api/Practice

Creates a new Practice. If configured will allow the updating of existing practices (located via ExternalId).

Request Information

URI Parameters

None.

Body Parameters

Collection of Practice

Name	Description	Type	Additional information
ExternalId	External ID	string	Required
PracticeName	Practice Name	string	Required Max length: 200
Email	Primary contact email address	string	Max length: 50
IsActive	Sets the practice to active. Defaults to True.	boolean	None.
PracticeAbbreviation	[CQM] Abbreviation to use for login screen if system is configured to use abbreviation logins	string	None.
PracticeReportingType	[CQM Required] Practice Reporting Type - EP-I, EP-G, or EH.	string	None.
PracticeNameForCCDA	[CEHR] Practice Name for CCDA	string	Max length: 200
Address	[CEHR & CQM Phone Required] Street Address & Phone Numbers	Address	None.
PracticeIdentifiers	Practice identifiers (such as TIN and CMS EHR Certification Number)	PracticeIdentifiers	None.
CqmConfigurationSettings	[CQM] Practice configuration settings	CqmPracticeSettings	None.
RepositoryDetails	[CQM] Data source settings. If global configuration DefaultPracticeSetting_Enabled is set true and RepositoryDetails is unpopulated, the new practice RepositoryDetails will be populated from the globally configured defaults.	RepositoryDetails	None.
SubmissionSettings	[CQM] Dynamic Health IT Qualified Registry submission related settings	SubmissionSettings	None.
DirectSettings	[CEHR] Direct Onboarding settings	PracticeDirectSettings	None.
FhirServerSettings	[CEHR] FHIR Server related settings	PracticeFhirSettings	None.
OnboardingInstructions	Provides processing instructions to the Onboarding API for this item	PracticeInstructions	None.
DynamicIqPracticeDetails	Dynamic IQ Practice Information for File Transfers	DynamicIqPracticeDetails	None.
CustomerID		string	None.
FhirOrganizationInfoForServiceBaseURLs	[CEHR] FHIR Server related settings	PracticeFhirOrganizationInfoSettings	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ExternalId": "sample string 1",
    "PracticeName": "sample string 2",
    "Email": "sample string 3",
    "IsActive": true,
    "PracticeAbbreviation": "sample string 4",
    "PracticeReportingType": "sample string 5",
    "PracticeNameForCCDA": "sample string 6",
    "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"
    },
    "PracticeIdentifiers": {
      "TaxId": "sample string 1",
      "HcoId": "sample string 2",
      "SiteExternalId": "sample string 3",
      "CmsEhrCNumber": "sample string 4",
      "CpcPlusId": "sample string 5",
      "Domain": "sample string 6",
      "PracticeOID": "sample string 7",
      "MainPracticeExternalId": "sample string 8",
      "CertifiedOrganizationId": 9,
      "OrganizationalNpi": "sample string 10"
    },
    "CqmConfigurationSettings": {
      "CardView": true,
      "DisableZipUpload": true,
      "ReportRerunEnabled": true,
      "UsePerformerAsAuthorForQRDAs": true,
      "IsDataValidationActive": true,
      "LanguageSettings": {
        "PatientIdReplacementText": "sample string 1",
        "AccountNumberReplacementText": "sample string 2"
      }
    },
    "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"
    },
    "SubmissionSettings": {
      "FileSubmissionEnabled": true,
      "SubmissionType": "sample string 1",
      "SubmissionEnvironment": "sample string 2"
    },
    "DirectSettings": {
      "DirectDomain": "sample string 1"
    },
    "FhirServerSettings": {
      "OrganizationName": "sample string 1",
      "FhirConnectionString": "sample string 2",
      "FhirEndpointAbbreviation": "sample string 3",
      "UseFhirEndpointAbbreviation": true
    },
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true
    },
    "DynamicIqPracticeDetails": {
      "DynamicIqPracticePublicKey": "sample string 1"
    },
    "CustomerID": "sample string 7",
    "FhirOrganizationInfoForServiceBaseURLs": {
      "Name": {
        "OrganizationalName": "sample string 1"
      },
      "FacilityId": {
        "OrganizationNpi": "sample string 1",
        "OrganizationTin": "sample string 2",
        "OrganizationDuns": "sample string 3",
        "OrganizationClia": "sample string 4",
        "OrganizationNaic": "sample string 5",
        "CustomIdentifier": {
          "OidOrUri": "sample string 1",
          "Value": "sample string 2"
        }
      },
      "Location": {
        "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",
        "Email": "sample string 9",
        "URL": "sample string 10",
        "SMS": "sample string 11",
        "Other": "sample string 12"
      }
    }
  },
  {
    "ExternalId": "sample string 1",
    "PracticeName": "sample string 2",
    "Email": "sample string 3",
    "IsActive": true,
    "PracticeAbbreviation": "sample string 4",
    "PracticeReportingType": "sample string 5",
    "PracticeNameForCCDA": "sample string 6",
    "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"
    },
    "PracticeIdentifiers": {
      "TaxId": "sample string 1",
      "HcoId": "sample string 2",
      "SiteExternalId": "sample string 3",
      "CmsEhrCNumber": "sample string 4",
      "CpcPlusId": "sample string 5",
      "Domain": "sample string 6",
      "PracticeOID": "sample string 7",
      "MainPracticeExternalId": "sample string 8",
      "CertifiedOrganizationId": 9,
      "OrganizationalNpi": "sample string 10"
    },
    "CqmConfigurationSettings": {
      "CardView": true,
      "DisableZipUpload": true,
      "ReportRerunEnabled": true,
      "UsePerformerAsAuthorForQRDAs": true,
      "IsDataValidationActive": true,
      "LanguageSettings": {
        "PatientIdReplacementText": "sample string 1",
        "AccountNumberReplacementText": "sample string 2"
      }
    },
    "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"
    },
    "SubmissionSettings": {
      "FileSubmissionEnabled": true,
      "SubmissionType": "sample string 1",
      "SubmissionEnvironment": "sample string 2"
    },
    "DirectSettings": {
      "DirectDomain": "sample string 1"
    },
    "FhirServerSettings": {
      "OrganizationName": "sample string 1",
      "FhirConnectionString": "sample string 2",
      "FhirEndpointAbbreviation": "sample string 3",
      "UseFhirEndpointAbbreviation": true
    },
    "OnboardingInstructions": {
      "OnboardToCqmSolution": true,
      "OnboardToConnectEHR": true
    },
    "DynamicIqPracticeDetails": {
      "DynamicIqPracticePublicKey": "sample string 1"
    },
    "CustomerID": "sample string 7",
    "FhirOrganizationInfoForServiceBaseURLs": {
      "Name": {
        "OrganizationalName": "sample string 1"
      },
      "FacilityId": {
        "OrganizationNpi": "sample string 1",
        "OrganizationTin": "sample string 2",
        "OrganizationDuns": "sample string 3",
        "OrganizationClia": "sample string 4",
        "OrganizationNaic": "sample string 5",
        "CustomIdentifier": {
          "OidOrUri": "sample string 1",
          "Value": "sample string 2"
        }
      },
      "Location": {
        "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",
        "Email": "sample string 9",
        "URL": "sample string 10",
        "SMS": "sample string 11",
        "Other": "sample string 12"
      }
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfPractice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
  <Practice>
    <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>
    <CqmConfigurationSettings>
      <CardView>true</CardView>
      <DisableZipUpload>true</DisableZipUpload>
      <IsDataValidationActive>true</IsDataValidationActive>
      <LanguageSettings>
        <AccountNumberReplacementText>sample string 2</AccountNumberReplacementText>
        <PatientIdReplacementText>sample string 1</PatientIdReplacementText>
      </LanguageSettings>
      <ReportRerunEnabled>true</ReportRerunEnabled>
      <UsePerformerAsAuthorForQRDAs>true</UsePerformerAsAuthorForQRDAs>
    </CqmConfigurationSettings>
    <CustomerID>sample string 7</CustomerID>
    <DirectSettings>
      <DirectDomain>sample string 1</DirectDomain>
    </DirectSettings>
    <DynamicIqPracticeDetails>
      <DynamicIqPracticePublicKey>sample string 1</DynamicIqPracticePublicKey>
    </DynamicIqPracticeDetails>
    <Email>sample string 3</Email>
    <ExternalId>sample string 1</ExternalId>
    <FhirOrganizationInfoForServiceBaseURLs xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.Practice">
      <d3p1:FacilityId>
        <d3p1:CustomIdentifier>
          <d3p1:OidOrUri>sample string 1</d3p1:OidOrUri>
          <d3p1:Value>sample string 2</d3p1:Value>
        </d3p1:CustomIdentifier>
        <d3p1:OrganizationClia>sample string 4</d3p1:OrganizationClia>
        <d3p1:OrganizationDuns>sample string 3</d3p1:OrganizationDuns>
        <d3p1:OrganizationNaic>sample string 5</d3p1:OrganizationNaic>
        <d3p1:OrganizationNpi>sample string 1</d3p1:OrganizationNpi>
        <d3p1:OrganizationTin>sample string 2</d3p1:OrganizationTin>
      </d3p1:FacilityId>
      <d3p1:Location>
        <d3p1:City>sample string 3</d3p1:City>
        <d3p1:Country>sample string 6</d3p1:Country>
        <d3p1:Email>sample string 9</d3p1:Email>
        <d3p1:Fax>sample string 8</d3p1:Fax>
        <d3p1:Other>sample string 12</d3p1:Other>
        <d3p1:Phone>sample string 7</d3p1:Phone>
        <d3p1:SMS>sample string 11</d3p1:SMS>
        <d3p1:State>sample string 4</d3p1:State>
        <d3p1:Street1>sample string 1</d3p1:Street1>
        <d3p1:Street2>sample string 2</d3p1:Street2>
        <d3p1:URL>sample string 10</d3p1:URL>
        <d3p1:Zip>sample string 5</d3p1:Zip>
      </d3p1:Location>
      <d3p1:Name>
        <d3p1:OrganizationalName>sample string 1</d3p1:OrganizationalName>
      </d3p1:Name>
    </FhirOrganizationInfoForServiceBaseURLs>
    <FhirServerSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.Practice">
      <d3p1:FhirConnectionString>sample string 2</d3p1:FhirConnectionString>
      <d3p1:FhirEndpointAbbreviation>sample string 3</d3p1:FhirEndpointAbbreviation>
      <d3p1:OrganizationName>sample string 1</d3p1:OrganizationName>
      <d3p1:UseFhirEndpointAbbreviation>true</d3p1:UseFhirEndpointAbbreviation>
    </FhirServerSettings>
    <IsActive>true</IsActive>
    <OnboardingInstructions xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.Practice">
      <d3p1:OnboardToConnectEHR>true</d3p1:OnboardToConnectEHR>
      <d3p1:OnboardToCqmSolution>true</d3p1:OnboardToCqmSolution>
    </OnboardingInstructions>
    <PracticeAbbreviation>sample string 4</PracticeAbbreviation>
    <PracticeIdentifiers>
      <CertifiedOrganizationId>9</CertifiedOrganizationId>
      <CmsEhrCNumber>sample string 4</CmsEhrCNumber>
      <CpcPlusId>sample string 5</CpcPlusId>
      <Domain>sample string 6</Domain>
      <HcoId>sample string 2</HcoId>
      <MainPracticeExternalId>sample string 8</MainPracticeExternalId>
      <OrganizationalNpi>sample string 10</OrganizationalNpi>
      <PracticeOID>sample string 7</PracticeOID>
      <SiteExternalId>sample string 3</SiteExternalId>
      <TaxId>sample string 1</TaxId>
    </PracticeIdentifiers>
    <PracticeName>sample string 2</PracticeName>
    <PracticeNameForCCDA>sample string 6</PracticeNameForCCDA>
    <PracticeReportingType>sample string 5</PracticeReportingType>
    <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>
    <SubmissionSettings>
      <FileSubmissionEnabled>true</FileSubmissionEnabled>
      <SubmissionEnvironment>sample string 2</SubmissionEnvironment>
      <SubmissionType>sample string 1</SubmissionType>
    </SubmissionSettings>
  </Practice>
  <Practice>
    <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>
    <CqmConfigurationSettings>
      <CardView>true</CardView>
      <DisableZipUpload>true</DisableZipUpload>
      <IsDataValidationActive>true</IsDataValidationActive>
      <LanguageSettings>
        <AccountNumberReplacementText>sample string 2</AccountNumberReplacementText>
        <PatientIdReplacementText>sample string 1</PatientIdReplacementText>
      </LanguageSettings>
      <ReportRerunEnabled>true</ReportRerunEnabled>
      <UsePerformerAsAuthorForQRDAs>true</UsePerformerAsAuthorForQRDAs>
    </CqmConfigurationSettings>
    <CustomerID>sample string 7</CustomerID>
    <DirectSettings>
      <DirectDomain>sample string 1</DirectDomain>
    </DirectSettings>
    <DynamicIqPracticeDetails>
      <DynamicIqPracticePublicKey>sample string 1</DynamicIqPracticePublicKey>
    </DynamicIqPracticeDetails>
    <Email>sample string 3</Email>
    <ExternalId>sample string 1</ExternalId>
    <FhirOrganizationInfoForServiceBaseURLs xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.Practice">
      <d3p1:FacilityId>
        <d3p1:CustomIdentifier>
          <d3p1:OidOrUri>sample string 1</d3p1:OidOrUri>
          <d3p1:Value>sample string 2</d3p1:Value>
        </d3p1:CustomIdentifier>
        <d3p1:OrganizationClia>sample string 4</d3p1:OrganizationClia>
        <d3p1:OrganizationDuns>sample string 3</d3p1:OrganizationDuns>
        <d3p1:OrganizationNaic>sample string 5</d3p1:OrganizationNaic>
        <d3p1:OrganizationNpi>sample string 1</d3p1:OrganizationNpi>
        <d3p1:OrganizationTin>sample string 2</d3p1:OrganizationTin>
      </d3p1:FacilityId>
      <d3p1:Location>
        <d3p1:City>sample string 3</d3p1:City>
        <d3p1:Country>sample string 6</d3p1:Country>
        <d3p1:Email>sample string 9</d3p1:Email>
        <d3p1:Fax>sample string 8</d3p1:Fax>
        <d3p1:Other>sample string 12</d3p1:Other>
        <d3p1:Phone>sample string 7</d3p1:Phone>
        <d3p1:SMS>sample string 11</d3p1:SMS>
        <d3p1:State>sample string 4</d3p1:State>
        <d3p1:Street1>sample string 1</d3p1:Street1>
        <d3p1:Street2>sample string 2</d3p1:Street2>
        <d3p1:URL>sample string 10</d3p1:URL>
        <d3p1:Zip>sample string 5</d3p1:Zip>
      </d3p1:Location>
      <d3p1:Name>
        <d3p1:OrganizationalName>sample string 1</d3p1:OrganizationalName>
      </d3p1:Name>
    </FhirOrganizationInfoForServiceBaseURLs>
    <FhirServerSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.Practice">
      <d3p1:FhirConnectionString>sample string 2</d3p1:FhirConnectionString>
      <d3p1:FhirEndpointAbbreviation>sample string 3</d3p1:FhirEndpointAbbreviation>
      <d3p1:OrganizationName>sample string 1</d3p1:OrganizationName>
      <d3p1:UseFhirEndpointAbbreviation>true</d3p1:UseFhirEndpointAbbreviation>
    </FhirServerSettings>
    <IsActive>true</IsActive>
    <OnboardingInstructions xmlns:d3p1="http://schemas.datacontract.org/2004/07/OnboardingApi.Api_Model.Practice">
      <d3p1:OnboardToConnectEHR>true</d3p1:OnboardToConnectEHR>
      <d3p1:OnboardToCqmSolution>true</d3p1:OnboardToCqmSolution>
    </OnboardingInstructions>
    <PracticeAbbreviation>sample string 4</PracticeAbbreviation>
    <PracticeIdentifiers>
      <CertifiedOrganizationId>9</CertifiedOrganizationId>
      <CmsEhrCNumber>sample string 4</CmsEhrCNumber>
      <CpcPlusId>sample string 5</CpcPlusId>
      <Domain>sample string 6</Domain>
      <HcoId>sample string 2</HcoId>
      <MainPracticeExternalId>sample string 8</MainPracticeExternalId>
      <OrganizationalNpi>sample string 10</OrganizationalNpi>
      <PracticeOID>sample string 7</PracticeOID>
      <SiteExternalId>sample string 3</SiteExternalId>
      <TaxId>sample string 1</TaxId>
    </PracticeIdentifiers>
    <PracticeName>sample string 2</PracticeName>
    <PracticeNameForCCDA>sample string 6</PracticeNameForCCDA>
    <PracticeReportingType>sample string 5</PracticeReportingType>
    <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>
    <SubmissionSettings>
      <FileSubmissionEnabled>true</FileSubmissionEnabled>
      <SubmissionEnvironment>sample string 2</SubmissionEnvironment>
      <SubmissionType>sample string 1</SubmissionType>
    </SubmissionSettings>
  </Practice>
</ArrayOfPractice>

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.