Public API

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

Projet: Heimdall Ă  deux pattes

Utilisez cette API pour autoriser l’accĂšs Ă  deux Ă©tapes et renvoyer un jeton JWT. Le jeton est requis pour l’autorisation dans toutes les autres demandes d’API.

📁 Collecte: Utilisateurs

Point final: obtenir des utilisateurs

Description:

Utilisez cette API pour obtenir un tableau d’objets contenant les donnĂ©es utilisateur de l’organisation.

PropriĂ©tĂ©s de l’objet:

Clé de propriétéValeur de la propriétéDescription
orgChaüne UUIDID de l’organisation parente de l’utilisateur.
sousChaĂźne UUIDNumĂ©ro d’abonnĂ© de l’utilisateur. UtilisĂ© comme identifiant unique pour l’utilisateur.
prĂ©nomchaĂźne de caractĂšresLe prĂ©nom de l’utilisateur.
nom de famillechaüne de caractùresLe nom de famille de l’utilisateur.
rîlechaüne de caractùresLe rîle de l’utilisateur au sein du systùme.
“utilisateur”, “administrateur”, “systùme”
npiNombre Ă  dix chiffres sous forme de chaĂźneUn National Provider Identifier est un numĂ©ro d’identification unique Ă  10 chiffres dĂ©livrĂ© aux prestataires de soins de santĂ© aux États-Unis par les Centers for Medicare et Medicaid Services.

Exemple d’objet de retour 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Ă©thode: GET

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

ParamĂštres de requĂȘte

Paramévaluer
sous{{$guid}}
groupe{{$guid}}

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

📁 Collection: Portails

Point final: obtenir des portails

Description:

Utilisez cette API pour obtenir un tableau d’objets contenant des donnĂ©es de portail d’organisation.

Les portails sont la reprĂ©sentation virtuelle d’un ordinateur utilisateur enregistrĂ© dans le systĂšme.

PropriĂ©tĂ©s de l’objet:

Clé de propriétéValeur de la propriétéDescription
Les donnéesChaßne UUIDLes données

Exemple d’objet de retour JSON:

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

MĂ©thode: GET

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

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

📁 Collecte: Groupes

Point final: obtenir des groupes

Utilisez cette API pour obtenir un tableau d’objets contenant des donnĂ©es de groupe d’organisation.

MĂ©thode: GET

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

RĂ©ponse: 200

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

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

Point final: créer un groupe

Utilisez cette API pour créer un nouveau groupe dans une organisation.

MĂ©thode: POST

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

Corps (brut)

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

RĂ©ponse: 200

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

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

Point final: obtenir l’ID de groupe par

Utilisez cette API pour obtenir un objet contenant des données pour un groupe spécifié dans une organisation.

MĂ©thode: GET

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

ParamĂštres de requĂȘte

Paramévaluer
identifiant{{temporaryGroupId}}
identifiant717e4c96-847b-4b87-b22e-8488a7802d9a

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

Point final: Modifier le groupe

Utilisez cette API pour modifier les donnĂ©es d’un groupe spĂ©cifiĂ© dans une organisation.

MĂ©thode: PATCH

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

Corps (brut)

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

RĂ©ponse: 204

null

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

Point final: Supprimer le groupe

Utilisez cette API pour supprimer un groupe spécifié dans une organisation.

MĂ©thode: SUPPRIMER

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

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

📁 Collecte: Horaire

Point final: obtenir le calendrier

Description:

Utilisez cette API pour obtenir un tableau d’objets contenant les donnĂ©es de rendez-vous planifiĂ©s d’une organisation.

Renvoie les propriĂ©tĂ©s de l’objet:

Clé de propriétéValeur de la propriétéDescription
fournisseurChaĂźne UUIDL’identifiant du mĂ©decin hĂ©bergeant la session. Extrait de la propriĂ©tĂ© sous d’un utilisateur.
patientobjetObjet contenant des propriétés décrivant un patient.
patient.patientIDchaĂźne de caractĂšresUn identifiant unique pour le patient.
patient.prénomchaßne de caractÚresLe prénom du patient.
patient.nomchaĂźne de caractĂšresLe nom de famille du patient.
patient.datedenaissanceDate au format année-mois-date
: AAAA-MM-JJ		La date de naissance du patient.
patient.sexechaüne de caractùresL’identifiant biologique du patient.
“M” ou “F”
ID de sessionChaßne UUIDUn identifiant unique reliant un rendez-vous planifié aux données du patient.

Fournir un identifiant de session lors de l’adhĂ©sion Ă  un portail extraira toutes les donnĂ©es patient associĂ©es pour le rendez-vous planifiĂ©.

Si les donnĂ©es du patient n’ont pas Ă©tĂ© fournies lors de la crĂ©ation du rendez-vous planifiĂ©, aucune donnĂ©e ne sera extraite.
identifiant de portailnumĂ©ro Ă  64 chiffresL’ID du portail dans lequel le rendez-vous doit avoir lieu.
Heure de débutDate au format ISOHeure de début en dehors du rendez-vous prévu.
temps d’arrĂȘtDate au format ISOHeure de fin du rendez-vous programmĂ©.

Exemple d’objet de retour 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Ă©thode: GET

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

ParamĂštres de requĂȘte

Paramévaluer
date de début2021-01-01
date d’arrĂȘt2021-12-03
par pagedix
page0
portails.nomPortableTéléclinique

RĂ©ponse: 200

[]

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

Point final: créer un élément de planification

Description:

Utilisez cette API pour créer un nouveau rendez-vous planifié pour une organisation.

Renvoie les propriĂ©tĂ©s de l’objet:

Faux si le rendez-vous planifié a été créé avec succÚs

Vrai si le rendez-vous planifié a été créé avec succÚs

Exemple d’objet de retour JSON:

true

MĂ©thode: PUT

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

Corps (brut)

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

RĂ©ponse: 200

true

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

Point final: obtenir l’élĂ©ment de planification par ID

Description:

Utilisez cette API pour obtenir un objet contenant des donnĂ©es pour un rendez-vous planifiĂ© spĂ©cifiĂ© d’une organisation.

Renvoie les propriĂ©tĂ©s de l’objet:

Clé de propriétéValeur de la propriétéDescription
Les donnéesLes donnéesLes données

Exemple d’objet de retour JSON:

{
    // TODO
}

MĂ©thode: GET

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

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

Point final: Supprimer l’élĂ©ment de planification

Utilisez cette API pour supprimer un rendez-vous planifié spécifié dans une organisation.

MĂ©thode: SUPPRIMER

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

RĂ©ponse: 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\"}}"
}

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

📁 Collecte: Organisation

Point final: obtenir des organisations

Utilisez cette API pour obtenir un objet contenant des attributs de données pour une organisation.

Exemple d’objet de rĂ©ponse:

[
    {
        "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Ă©thode: GET

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

ParamĂštres de requĂȘte

Paramévaluer
page0

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

Point final: Créer une organisation

Utilisez cette API pour créer une nouvelle organisation.

MĂ©thode: PUT

{{baseUrl}}/api/v1/org

Corps (brut)

{
    "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}}"
    }
}

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

Point final: Obtenir l’organisation par ID

Utilisez cette API pour obtenir un objet contenant des données pour une organisation spécifiée.

MĂ©thode: GET

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

RĂ©ponse: 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"
    }
}

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

Point final: Modifier l’organisation par ID

Utilisez cette API pour modifier les attributs de donnĂ©es d’une organisation spĂ©cifiĂ©e. La demande est effectuĂ©e Ă  l’aide de l’identifiant de l’organisation.

MĂ©thode: PATCH

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

Corps (brut)

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

RĂ©ponse: 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"
}

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

Point final: Supprimer l’organisation par ID

Utilisez cette API pour supprimer une organisation spécifiée par son ID.

MĂ©thode: SUPPRIMER

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

RĂ©ponse: 204

null

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

Point final: Obtenir l’organisation par slug

Utilisez cette API pour obtenir un objet contenant les attributs de donnĂ©es d’une organisation spĂ©cifiĂ©e. La demande est faite Ă  l’aide du slug de l’organisation.

MĂ©thode: GET

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

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

Propulsé par: postman-to-markdown