POST api/Practice/OrganizationInfo
Allow Insert and Update of the tblPracticeConfiguration and tblPractice tables to support populating HTI-1 Service Base URLs Organization Info of existing practices (located via ExternalId)
Request Information
URI Parameters
None.
Body Parameters
Collection of PracticeOrganizationInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| ExternalId | string |
None. |
|
| FhirOrganizationInfoForServiceBaseURLs | PracticeFhirOrganizationInfoSettings |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"ExternalId": "sample string 1",
"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",
"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:
<ArrayOfPracticeOrganizationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnboardingApi.ApiModel">
<PracticeOrganizationInfo>
<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>
</PracticeOrganizationInfo>
<PracticeOrganizationInfo>
<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>
</PracticeOrganizationInfo>
</ArrayOfPracticeOrganizationInfo>
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.