Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Add a new location to a group

Adds a new location to an existing group, creating the necessary location and group-location membership records (and, if address information is provided, linked address records). Designed for batch ingestion workflows where location data arrives from an external roster or source system, but also suitable for individual location additions. The request body only strictly requires locationData as an object — no field inside it is independently enforced by request validation. Not idempotent — repeated calls create additional location records; to update an existing location use PUT /groups/{groupId}/locations.

post/groups/{groupId}/locations

Path parameters

groupIdstring required

Group ID (certifyGroupId)

Headers

tenant-idstring

Request body

locationDataobject required

Core location data (name, type, etc.)

groupLocationDataobject

Group location specific data (acceptsNewPatients, etc.)

tenantGroupLocationDataobject

Tenant group location specific data (effectiveDate, etc.)

tagsstring[]

List of tags for categorization

hospitalAdmittingPrivilegesobject

Hospital admitting privileges information

includePractitionersboolean

If true, enrolls all location practitioners to the networks with their respective specialties

Response

Successfully added location to group

tenantIdstring

ID of the tenant

tenantGroupIdstring

ID of the tenant group

coreLocationIdstring

ID of the created core location

groupLocationIdstring

ID of the created group location

tenantGroupLocationIdstring

ID of the created tenant group location

coreAddressIdsstring[]

List of created core address IDs

locationAddressRelationshipIdsstring[]

List of created location-entity address relationship IDs

groupSpecialtyRelationshipIdsstring[]

List of created group specialty relationship IDs

specialtyRelationshipIdsstring[]

List of created location specialty relationship IDs

tenantGroupNetworkIdsstring[]

List of created tenant group network relationship IDs

tenantGroupLocationNetworkIdsstring[]

List of created tenant group location network relationship IDs

tenantGroupNetworkSpecialtyIdsstring[]

List of created tenant group network specialty relationship IDs

statusstring

Status of the operation

Example response

{
  "tenantId": "tenant-123",
  "tenantGroupId": "tg-456",
  "coreLocationId": "loc-123",
  "groupLocationId": "gl-456",
  "tenantGroupLocationId": "tgl-789",
  "coreAddressIds": [
    "addr-101",
    "addr-102"
  ],
  "locationAddressRelationshipIds": [
    "lea-201",
    "lea-202"
  ],
  "groupSpecialtyRelationshipIds": [
    "group-spec-rel-1",
    "group-spec-rel-2"
  ],
  "specialtyRelationshipIds": [
    "loc-spec-rel-1",
    "loc-spec-rel-2"
  ],
  "tenantGroupNetworkIds": [
    "tgn-301",
    "tgn-302"
  ],
  "tenantGroupLocationNetworkIds": [
    "tgln-401",
    "tgln-402"
  ],
  "tenantGroupNetworkSpecialtyIds": [
    "tgns-501",
    "tgns-502"
  ],
  "status": "created"
}