Public API

import { ORGANIZATION } from ‘@agnesuserguide/config’;

Projeto: Heimdall Duas Pernas

Use esta API para autorizar o acesso de duas pernas e retornar um token JWT. O token é necessário para autorização em todas as outras solicitações de API.

📁 Coleção: Usuários

Ponto final: obter usuários

Descrição:

Use esta API para obter uma matriz de objetos contendo dados do usuário da organização.

Propriedades do objeto:

Chave de propriedade	Valor da propriedade	Descrição
organização	Cadeia de caracteres UUID	O ID da organização pai do usuário.
sub	Cadeia de caracteres UUID	Número de assinante do usuário. Usado para como um identificador exclusivo para o usuário.
primeiro nome	corda	O primeiro nome do usuário.
sobrenome	corda	O sobrenome do usuário.
papel	corda	A função do usuário dentro do sistema. “usuário”, “administrador”, “sistema”
npi	Número de dez dígitos como string	Um Identificador Nacional do Provedor é um número de identificação exclusivo de 10 dígitos emitido para prestadores de serviços de saúde nos Estados Unidos pelos Centros de Serviços Medicare e Medicaid.

Exemplo de objeto de retorno JSON:

[
    {
        "org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "username": "frodobaggins@email.com",
        "firstname": "Frodo",
        "lastname": "Baggins",
        "role": "user",
        "npi": null
    },
    {
        "org": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "sub": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "username": "bilbobaggins@email.com",
        "firstname": "Bilbo",
        "lastname": "Baggins",
        "role": "administrator",
        "npi": null
    }
]

Método: GET

{{baseUrl}}/api/v1/org/{{orgId}}/users

Parâmetros de consulta

Param	valor
sub	{{$guid}}
grupo	{{$guid}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Coleção: Portais

Ponto final: obter portais

Descrição:

Use esta API para obter uma matriz de objetos contendo dados do Portal da organização.

Os portais são a representação virtual de um computador de usuário registrado no sistema.

Propriedades do objeto:

Chave de propriedade	Valor da propriedade	Descrição
dados	Cadeia de caracteres UUID	dados

Exemplo de objeto de retorno JSON:

[
    {
        "data": "data"
    },
    {
        "data": "data"
    }
]

Método: GET

{{baseUrl}}/api/v1/org/{{orgId}}/portals

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Coleção: Grupos

Ponto final: obter grupos

Use esta API para obter uma matriz de objetos contendo dados do grupo de organização.

Método: GET

{{baseUrl}}/api/v1/org/{{orgId}}/groups

Resposta: 200

[
    {
        "id": "3s5*****-****-****-****-************",
        "org": "7ag*****-****-****-****-************",
        "name": "Administrators",
        "meta": {},
        "members": []
    },
    {
        "id": "9sd*****-****-****-****-************",
        "org": "53f*****-****-****-****-************",
        "name": "Test",
        "meta": {},
        "members": ["9ba*****-****-****-****-************"]
    }
]

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: criar grupo

Use esta API para criar um novo grupo em uma organização.

Método: POST

{{baseUrl}}/api/v1/org/{{orgId}}/groups

Corpo (cru)

{
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "meta": {},
    "members": []
}

Resposta: 200

{
    "id": "04a*****-****-****-****-************",
    "org": "040*****-****-****-****-************",
    "name": "back-end hard drive",
    "meta": {
        "meta": {}
    },
    "members": []
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: obter grupo por ID

Use esta API para obter o objeto que contém dados para um grupo especificado em uma organização.

Método: GET

{{baseUrl}}/api/v1/org/{{orgId}}/groups?id={{temporaryGroupId}}

Parâmetros de consulta

Param	valor
eu ia	{{temporaryGroupId}}
eu ia	717e4c96-847b-4b87-b22e-8488a7802d9a

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: Modificar grupo

Use esta API para modificar dados de um grupo especificado em uma organização.

Método: PATCH

{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}

Corpo (cru)

{
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "meta": {},
    "members": ["{{userId}}"]
}

Resposta: 204

null

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: Excluir grupo

Use esta API para excluir um grupo especificado em uma organização.

Método: DELETE

{{baseUrl}}/api/v1/org/{{orgId}}/groups/{{temporaryGroupId}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Coleta: Agendamento

Ponto final: obter agendamento

Descrição:

Use esta API para obter uma matriz de objetos contendo os dados de compromissos agendados de uma organização.

Propriedades do objeto de retorno:

Chave de propriedade	Valor da propriedade	Descrição
fornecedor	Cadeia de caracteres UUID	O ID do médico que está realizando a sessão. Recuperado da propriedade sub de um usuário.
paciente	objeto	Um objeto contendo propriedades que descrevem um paciente.
paciente.pacienteID	corda	Um identificador exclusivo para o paciente.
paciente.sobrenome	corda	O primeiro nome do paciente.
paciente.nome	corda	O sobrenome do paciente.
paciente.data de nascimento	Data no formato ano-mês-data : AAAA-MM-DD	Data de nascimento do paciente.
paciente.sexo	corda	O identificador biológico do paciente. “M” ou “F”
identificação de sessão	Cadeia de caracteres UUID	Um ID exclusivo que conecta uma consulta agendada com os dados do paciente. Fornecer um ID de sessão ao ingressar em um portal extrairá todos os dados do paciente associados à consulta agendada. Se os dados do paciente não foram fornecidos ao criar a consulta agendada, nenhum dado será inserido.
portalID	número de 64 dígitos	A ID do portal em que o compromisso está programado para ocorrer.
hora de início	Data formatada ISO	Comece o tempo fora do compromisso agendado.
pare o tempo	Data formatada ISO	Hora de término do compromisso agendado.

Exemplo de objeto de retorno JSON:

[
    {
        "providerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "patient": {
            "patientId": "c",
            "firstName": "Larry",
            "lastName": "Friesen",
            "birthDate": "2001-12-02",
            "sex": "M"
        },
        "sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "portalId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
        "startTime": "2021-12-02T06:07:49.000Z",
        "stopTime": "2021-12-02T08:00:24.000Z"
    }
]

Método: GET

{{baseUrl}}/api/v1/org/{{orgId}}/schedule?startDate=2021-01-01&perPage=10&page=0

Parâmetros de consulta

Param	valor
data de início	01-01-2021
data de parada	03-12-2021
por página	10
página	0
portais.nome	Teleclínica Portátil

Resposta: 200

[]

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: criar item de programação

Descrição:

Use esta API para criar um novo compromisso agendado para uma organização.

Propriedades do objeto de retorno:

True se o compromisso agendado foi criado com sucesso

False se o compromisso agendado foi criado com sucesso

Exemplo de objeto de retorno JSON:

true

Método: PUT

{{baseUrl}}/api/v1/org/{{orgId}}/schedule

Corpo (cru)

{
    "providerId": "{{userId}}",
    "patient": {
        "patientId": "{{$randomAlphaNumeric}}",
        "firstName": "{{$randomFirstName}}",
        "lastName": "{{$randomLastName}}",
        "birthDate": "{{randomDatePast}}",
        "sex": "M"
    },
    "sessionId": "{{$randomUUID}}",
    "portalId": "{{portalId}}",
    "startTime": "{{$randomDateRecent}}",
    "stopTime": "{{$randomDateRecent}}"
}

Resposta: 200

true

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: obter item de programação por ID

Descrição:

Use esta API para obter um objeto contendo dados para um compromisso agendado especificado de uma organização.

Propriedades do objeto de retorno:

Chave de propriedade	Valor da propriedade	Descrição
dados	dados	dados

Exemplo de objeto de retorno JSON:

{
    // TODO
}

Método: GET

{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: Excluir item de programação

Use esta API para excluir um compromisso agendado especificado em uma organização.

Método: DELETE

{{baseUrl}}/api/v1/org/{{orgId}}/schedule/{{temporaryScheduleId}}

Resposta: 200

{
    "sessionId": "1560f626-117f-4263-a068-46963357f30a",
    "providerId": null,
    "portalId": "8ad982843f36037b16450dd99c48663ecb6e031364241f146a906642efa9e101",
    "startTime": "2021-12-02T06:07:49.000Z",
    "stopTime": "2021-12-02T08:00:24.000Z",
    "meta": "{\"providerId\":\"b2f8d193-4e72-4d76-9dbf-677c86786ecb\",\"patient\":{\"patientId\":\"c\",\"firstName\":\"Larry\",\"lastName\":\"Friesen\",\"birthDate\":\"{{randomDatePast}}\",\"sex\":\"M\"}}"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Coleção: Organização

Ponto final: obter organizações

Use esta API para obter um objeto contendo atributos de dados para uma organização.

Exemplo de objeto de resposta:

[
    {
        "id": "2xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parent": "0xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
        "name": "{ORGANIZATION.names.short} Demo Child",
        "slug": "{ORGANIZATION.names.short}-demo-child",
        "config": {
            "emr_provider": "redox",
            "datascan": {
                "api": {
                    "token": ""
                }
            },
            "ldap": {
                "url": null,
                "bindDN": null,
                "bindCredentials": null,
                "searchBase": "",
                "adminGroupDN": "",
                "users": {
                    "class": "inetOrgPerson",
                    "subAttribute": "",
                    "usernameAttribute": ""
                },
                "groups": {
                    "class": "groupOfUniqueNames",
                    "idAttribute": "dn",
                    "nameAttribute": "cn",
                    "memberAttribute": "uniqueMember"
                }
            },
            "emr_provider_org": null,
            "logo": null,
            "pcc": {
                "clientId": "",
                "clientSecret": ""
            },
            "identity_provider": "amd",
            "azuread": {
                "client_id": "",
                "client_secret": "",
                "tenant": "",
                "admin_group": "",
                "npi_claim": "sub"
            },
            "agnes": {
                "whitelabel": "",
                "webPageTimeout": 15,
                "maxUsers": 2,
                "leftWindow": "medicalvideo",
                "rightWindow": null,
                "iframes": [],
                "modules": {
                    "chat": {
                        "enabled": true
                    },
                    "notes": {
                        "enabled": true,
                        "templates": []
                    },
                    "sessiondocs": {
                        "coverLogoHeight": 0,
                        "headerLogoHeight": 0
                    },
                    "vc": {
                        "enabled": true,
                        "force": false,
                        "iceTransportPolicy": "all"
                    },
                    "vitals": {
                        "enabled": true,
                        "temperatureUnits": "fahrenheit",
                        "bloodpressureUnits": "mmhg",
                        "heightUnits": "inches",
                        "weightUnits": "pounds"
                    }
                }
            },
            "identity_provider_org": null,
            "redox": {
                "destination_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "patient": {
                    "id_type": "EHRID"
                }
            }
        },
        "metadata": {
            "emr_provider": "redox",
            "emr_provider_org": null
        }
    },
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "parent": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "children": [],
        "name": "I am a sibling organization",
        "slug": "sibling",
        "config": {},
        "metadata": {
            "emr_provider": null,
            "emr_provider_org": null
        }
    },
    {
        "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "parent": null,
        "children": ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
        "name": "{ORGANIZATION.names.short} Demo",
        "slug": "{ORGANIZATION.names.short}-demo",
        "config": {
            "agnes": {
                "webPageTimeout": 1500,
                "maxUsers": 99,
                "modules": {
                    "notes": {
                        "templates": [
                            {
                                "template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint/Reason for visit:   \n\nVital Signs   \n-SpO2: {{vitals.spo2}}      -Pulse: {{vitals.pulse}}   \n-Blood Pressure: {{vitals.bloodpressure}}   -Temperature: {{vitals.temperature}}   -Height: {{vitals.height}}   -Weight: {{vitals.weight}}   \n-Blood Glucose (mg/dL):    \n\nAdditional Encounter Notes:",
                                "name": "Patient Intake Form"
                            },
                            {
                                "template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
                                "name": "Provider Encounter Notes"
                            }
                        ]
                    },
                    "vitals": {
                        "temperatureUnits": "celsius"
                    }
                },
                "whitelabel": null,
                "iframes": [],
                "rightWindow": "videoconference",
                "leftWindow": "documents"
            },
            "logo": "url",
            "identity_provider": "amd",
            "emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'",
            "identity_provider_org": "''",
            "emr_provider": "redox"
        },
        "metadata": {
            "emr_provider": "redox",
            "emr_provider_org": "'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'"
        }
    }
]

Método: GET

{{baseUrl}}/api/v1/org?page=0

Parâmetros de consulta

Param	valor
página	0

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: criar organização

Use esta API para criar uma nova organização.

Método: PUT

{{baseUrl}}/api/v1/org

Corpo (cru)

{
    "id": "{{$randomUUID}}",
    "name": "{{$randomAdjective}} {{$randomNoun}}",
    "slug": "{{$randomCatchPhraseNoun}}",
    "parent": "{{orgId}}",
    "config": {
        "agnes": {
            "webPageTimeout": 1500,
            "maxUsers": 99,
            "modules": {
                "notes": {
                    "templates": [
                        {
                            "template": "Telemedicine Patient Intake Form\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nLocal Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint/Reason for visit:   \n\nVital Signs   \n-SpO2: {{vitals.spo2}}      -Pulse: {{vitals.pulse}}   \n-Blood Pressure: {{vitals.bloodpressure}}   -Temperature: {{vitals.temperature}}   -Height: {{vitals.height}}   -Weight: {{vitals.weight}}   \n-Blood Glucose (mg/dL):    \n\nAdditional Encounter Notes:",
                            "name": "Patient Intake Form"
                        },
                        {
                            "template": "Telemedicine Provider Encounter Notes\n\nPatient: {{patient.lastName}}, {{patient.firstName}} {{patient.middleInitial}} \nPatient ID: {{patient.patientId}} \nSex: {{patient.sex}} \nBirthdate {{patient.birthDate}} \n\nOrganization Name: {ORGANIZATION.names.long}\nClinic Location:   Chelmsford MA 01824\nObserving Provider: {{user.fname}} {{user.lname}}  \n\nChief Complaint of patient:\n\nDiagnosis:\n\nTreatment Plan:\n\nAdditional Encounter Notes:",
                            "name": "Provider Encounter Notes"
                        }
                    ]
                },
                "vitals": {
                    "temperatureUnits": "celsius"
                }
            },
            "whitelabel": null,
            "iframes": [],
            "rightWindow": "videoconference",
            "leftWindow": "documents"
        },
        "logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b",
        "identity_provider": "amd",
        "emr_provider_org": "{{$randomUUID}}",
        "identity_provider_org": "{{$randomUUID}}",
        "emr_provider": "redox"
    },
    "metadata": {
        "emr_provider": "redox",
        "emr_provider_org": "{{$randomUUID}}"
    }
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: obter organização por ID

Use esta API para obter um objeto contendo dados para uma organização especificada.

Método: GET

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

Resposta: 200

{
    "name": "1080p panel",
    "id": "9038420b-c49c-4b76-b87d-94052ba4c4df",
    "slug": "groupware",
    "config": {
        "logo": "https://agnes-connect.s3.amazonaws.com/logos/04036433-63cf-4823-b222-af007005720b"
    }
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: modificar organização por ID

Use esta API para modificar os atributos de dados de uma organização especificada. A solicitação é feita usando o ID da organização.

Método: PATCH

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

Corpo (cru)

{
    "id": "{{temporaryOrgId}}",
    "name": "{ORGANIZATION.names.short} Mod",
    "slug": "{ORGANIZATION.names.short}-mod"
}

Resposta: 403

{
    "type": "ForbiddenError",
    "message": "Forbidden",
    "stack": "ForbiddenError: Forbidden\n    at assert (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/http-assert/index.js:8:9)\n    at patchOrganizations (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/actions/organization/patch.js:24:9)\n    at runMicrotasks (<anonymous>)\n    at processTicksAndRejections (internal/process/task_queues.js:93:5)\n    at async nocacheMiddleware (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koajs-nocache/index.js:29:5)\n    at async bodyParser (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-bodyparser/index.js:95:5)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/api/v1/index.js:18:13\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:58:5\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/helpers/initialize_app.js:246:5\n    at async errorHandler (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/oidc-provider/lib/shared/error_handler.js:23:7)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-mount/index.js:52:26\n    at async serve (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-static/index.js:53:9)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:72:17\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-compress/index.js:43:5\n    at async logger (/hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/node_modules/koa-logger/index.js:67:7)\n    at async /hab/pkgs/amdglobal/heimdall/2.3.5/20211213214300/app/packages/server/lib/index.js:49:13"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: Excluir organização por ID

Use esta API para excluir uma organização especificada por seu ID.

Método: DELETE

{{baseUrl}}/api/v1/org/{{temporaryOrgId}}

Resposta: 204

null

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ponto final: obter organização por lesma

Use esta API para obter um objeto que contém os atributos de dados de uma organização especificada. A solicitação é feita usando o slug da organização.

Método: GET

{{baseUrl}}/api/v1/org/slug/{{orgSlug}}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Desenvolvido por: carteiro para remarcação