Practitioner

HTTP verbs supported

Akinox-FHIR-Practitioner-Swagger

GET

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

Route that helps fetch different practitioners. It will return one entity.

  • Fetch any practitioner we have in our database with his logical identifier {id}. The logical identifier is a GUID.
    • The logical identifier can be found here {domain}/neo-atlas/fhir/Practitioner.

Here are different get examples here

  • Responses
    • OK (200)
      • The practitioner 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 practitioner wasn't found.
    • Gone (410)
      • The practitioner is inactive.
    • InternalServerError (500)
      • An unexpected error has occured.

{domain}/neo-atlas/fhir/Practitioner

Route that searches different practitioner. It will return a Bundle.

  • Search any practitioner using his FHIR identifier (LN - License Number).

Here are different search examples click 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.

PUT

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

  • The JSON representing the FHIR practitioner needs to be in the request body.
  • The logical identifier {id} of the FHIR practitioner must be added as a path parameter.

Here are different put examples here

  • Reponses
    • OK (200)
      • The practitioner was updated and we return it in the response body with the meta updated.
    • BadRequest (400)
      • The logical identifier {id} in the path parameter string doesn't match the logical identifier in the JSON located in the request body.
      • The JSON that was passed in the request body is not FHIR valid, it will return a BadRequest with the operation outcome. See here for operation outcome information.
      • The FHIR practitioner entity does not fit our business rules.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • MethodNotAllowed (405)
      • The FHIR practitioner entity wasn't found.
    • Unprocessable Entity (422)
      • The FHIR practitioner doesn't fit our business rules.
    • InternalServerError (500)
      • An unexpected error has occured.

DELETE

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

Route that helps delete a practitioner.

  • Delete any practitioner we have in our database with his logical identifier {id}.

Here are different delete examples here

  • Responses
    • NoContent (204)
      • The practitioner entity was deleted.
      • The practitioner wasn't found.
    • BadRequest (400)
      • The parameter {id} is null, empty or consists of white-space characters.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • InternalServerError (500)
      • An unexpected error has occured.