PractitionerRole

HTTP verbs supported

akinox-fhir-practitionerrole-swagger

GET

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

Route that helps fetch different practitioner roles. It will return one entity.

  • Fetch any practitioner role we have in our database with his logical identifier {id}. The logical identifier is an integer.
    • The representation of a practitioner role consist of the link created between a practitioner and his affiliated site.
    • The logical identifier can be search here {domain}/neo-atlas/fhir/PractitionerRole.

Here are different get examples here

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

{domain}/neo-atlas/fhir/PractitionerRole

Route that searches for PractitionerRole. It will return a Bundle containing a list of PractitionerRole.

  • Search any PractitionerRole using his practitioner reference identifier (MD - Medical License Number).
  • Search any PractitionerRole using his organization's parent reference identifier (Msss Code).

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.

POST

{domain}/neo-atlas/fhir/PractitionerRole

Route that allows the practitioner role entity to be created.

  • The JSON representing the FHIR practitioner role needs to be in the request body.

Here are different post examples here

  • Reponses
    • Created (201)
      • The practitioner role was created and we return the FHIR practitioner role in the response body with the id assigned.
      • The logical identifier from the creation will be situated in the response headers under the location property.
        • For example
          • location: PractitionerRole/223
    • BadRequest (400)
      • 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.
      • JSON format is invalid.
      • The FHIR practitioner role entity is a duplicate.
      • The FHIR practitioner role entity does not fit our business rules.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • Unprocessable Entity (422)
      • The practitioner wasn't found.
      • The sites were not found.
      • The sites found are not linked together.
      • The practitioner role already exists.
    • IntervalServerError (500)
      • An unexpected error has occured.

DELETE

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

Route that helps delete a practitioner roles.

  • Delete any practitioner role we have in our database with his logical identifier {id}.
    • The representation of a practitioner role consist of the link created between a practitioner and his affiliated site.

Here are different get examples here

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