ServiceRequest

HTTP verbs supported

akinox-fhir-servicerequest-swagger

GET

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

Route that fetch requested ServiceRequest. It returns one entity.

  • The logical identifier {id} of the FHIR ServiceRequest must be added as a path parameter.

Here are different get examples here

  • Responses
    • OK (200)
      • The ServiceRequest 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 ServiceRequest wasn't found.
    • Unprocessable Entity (422)
      • The ServiceRequest entity does not fit our FHIR business rules.
        • For example : As of Version 1, we only support Dermatology clinical domain.
    • InternalServerError (500)
      • An unexpected error has occured.

{domain}/neo-atlas/fhir/ServiceRequest

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

  • Search any ServiceRequest using his patient reference identifier (PCI - Patient Composed Identifier).
  • Search any ServiceRequest using his requester reference identifier (MD - Medical License Number).
  • Search any ServiceRequest using his requester 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/ServiceRequest

Route that allows the ServiceRequest entity to be created.

  • The JSON of the FHIR ServiceRequest must be in the request body.

Here are different post examples here

  • Reponses
    • Created (201)
      • The ServiceRequest was created and returned as a FHIR ServiceRequest in the response body with the id assigned and the meta updated.
      • The logical identifier from the creation will be situated as a fhir reference in the response headers under the location property.
        • For example
          • location: ServiceRequest/bb1682da-b744-4fa6-b8a5-d00f0eaa88a9
    • 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.
      • Payload JSON format is invalid.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • Unprocessable Entity (422)
      • The FHIR ServiceRequest entity does not fit our business rules.
      • The FHIR ServiceRequest entity is a duplicate.
    • InternalServerError (500)
      • An unexpected error has occured.

DELETE

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

Route that allows the ServiceRequest entity to be deleted.

  • The logical identifier {id} of the FHIR ServiceRequest must be added as a path parameter.

Here are different put examples here

  • Responses
    • NoContent (204)
      • The ServiceRequest entity was deleted.
      • The ServiceRequest wasn't found.
    • BadRequest (400)
      • The parameter {id} is null, empty or consists of white-space characters.
    • Forbidden (403)
      • Insufficient rights to the ressource.
    • Unprocessable Entity (422)
      • The ServiceRequest entity does not fit our FHIR business rules.
        • For example : As of Version 1, we only support Dermatology clinical domain.
      • The ServiceRequest entity was already deleted.
    • InternalServerError (500)
      • An unexpected error has occured.