Organization

HTTP verbs supported

akinox-fhir-organization-swagger

GET

{domain}/neo-atlas/fhir/Organization/{id}

Route that helps retreive different establishments and departments. It will return one entity.

  • Fetch an establishments or departments we have in our database with his logical identifier {id}.
    • Fetch an establishment by passing a GUID.
      • The logical identifier from the establishment can be found here {domain}/neo-atlas/fhir/Organization
    • Fetch a department by passing a short.
      • The logical identifier from the department can be found here {domain}/neo-atlas/fhir/Organization

For different get examples click here

  • Responses
    • OK (200)
      • The organization entity is in the response body.
    • BadRequest (400)
      • The parameter {id} is null, empty or consists of white-space characters.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • NotFound (404)
      • The department or the establishment wasn't found.
    • Gone (410)
      • The department or the establishment is inactive.
    • InternalServerError (500)
      • An unexpected error has occured.

{domain}/neo-atlas/fhir/Organization

Route that searches different establishment and department. It will return a Bundle containing hospitals and/or departments.

  • Search any establishment with a specific code regarding his identifier.
  • Search any department with a specific parent organization MsssCode identifier.

Here are different search examples here

  • Reponses
    • OK (200)
      • The Bundle is in the response body.
    • BadRequest (400)
      • There was an error binding the search parameters.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • InternalServerError (500)
      • An unexpected error has occured.