Security
bearer
The address of the site
Example:
{ "street": "123 Main St", "city": "New York", "zipCode": "10001" }
Output data store type for the site. Defaults based on integrationType if not provided.
Enum:"FHIR_R4""AHDS_V1""CUSTOM""NONE"
Example:"FHIR_R4"
If true, AHDS store will be provisioned with seed data included. If false or omitted (default), AHDS store will have empty schema only. Only applies when outputDataStoreType is AHDS_V1.
Example:false
Custom Integration type for the site
Value:"FILE_UPLOAD"
Example:"FILE_UPLOAD"
The cloud based organization name for the site
Example:"cloud-organization-name"
- Mock serverhttps://docs.axiomera.com/_mock/apis/heydonto/openapi/site
- Sandboxhttps://api-staging.heydonto.com/site
- Productionhttps://api.heydonto.com/site
curl -i -X POST \
https://docs.axiomera.com/_mock/apis/heydonto/openapi/site \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Downtown Clinic",
"address": {
"street": "123 Main St",
"city": "New York",
"zipCode": "10001"
},
"googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
"clientAccountId": 1,
"organizationId": 1,
"brandId": 2,
"phoneNumber": "+1-555-555-5555",
"website": "https://www.downtownclinic.com",
"anyDeskIp": "192.168.1.1",
"practiceManagementSystemId": 123,
"integrationType": "PMS",
"outputDataStoreType": "FHIR_R4",
"seedAhdsStore": false,
"customIntegrationType": "FILE_UPLOAD",
"siteManagerUserId": 45,
"cloudUserName": "cloud-user",
"cloudUserPassword": "cloud-user-password",
"cloudOrganizationName": "cloud-organization-name",
"cloudLoginUrl": "https://cloud-login-url.com"
}'Site created successfully.
The ID of the practice management system used by the site
Example:202
Integration type for the site
Default:"PMS"
Enum:"PMS""CUSTOM"
Example:"PMS"
Output data store type for the site
Default:"FHIR_R4"
Enum:"FHIR_R4""AHDS_V1""CUSTOM""NONE"
Example:"FHIR_R4"
The date of the most recent sync with the site
Example:"2021-06-01T12:00:00Z"
The name of the cloud organization for the site
Example:"HealthCorp Cloud"
The practice management system used by the site
Response
{ "id": 123, "name": "Downtown Clinic", "address": { "lat": 37.7749, "lng": -122.4194, "url": "https://maps.google.com/?q=123+Main+St", "formatted_address": "123 Main St, San Francisco, CA 94103" }, "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4", "phoneNumber": "+1 (555) 123-4567", "website": "https://downtownclinic.com", "anyDeskIp": "192.168.1.100", "createdByUserId": 202, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "deletedAt": "null", "clientAccountId": 456, "organizationId": 789, "brandId": 101, "practiceManagementSystemId": 202, "integrationType": "PMS", "outputDataStoreType": "FHIR_R4", "licenseKey": "XXX-YYY-ZZZ-AAA-BBB", "fhirStoreId": "fhir-store-123", "firstSyncDate": "2021-05-15T12:00:00Z", "latestSyncDate": "2021-06-01T12:00:00Z", "synchronizationIsActive": true, "siteManagerUserId": 303, "cloudUserName": "downtown.clinic", "cloudUserPassword": "encrypted-password", "cloudOrganizationName": "HealthCorp Cloud", "cloudLoginUrl": "https://cloud.healthcorp.com/login", "clientAccount": { "id": 456, "title": "HealthCorp Client", "phoneNumber": "+1 (555) 123-4567", "website": "https://healthcorp.com", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "organization": { "id": 123, "title": "HealthCorp", "website": "https://healthcorp.com", "isEnabled": true, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "brand": { "id": 789, "title": "HealthCorp Brand", "isEnabled": true, "organizationId": 123, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "practiceManagementSystem": { "id": 101, "title": "MedicalSoft Pro", "isCloudBased": true, "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "createdByUser": { "id": 202, "email": "john.doe@healthcorp.com", "firstName": "John", "lastName": "Doe", "role": "SITE_USER", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "siteUsers": [ { … } ], "siteManagerUser": { "id": 303, "email": "manager@healthcorp.com", "firstName": "Jane", "lastName": "Smith", "role": "SITE_MANAGER_USER", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "integrationTosAcceptedAt": "2021-08-01T00:00:00.000Z" }