MediRecords FHIR Implementation Guide
20221128 - ci-build


FamilyMemberHistory

The MediRecords FHIR API supports the following FamilyMemberHistory operations.

GET {API_URL}/v1/FamilyMemberHistory

This API interface enables the client to search FamilyMemberHistory instances from MediRecords repository. This is in compliance with this FamilyMemberHistory.

Query Parameters    
_count number Instruct the server regarding how many resources should be returned in a single page
code token A condition code or use the :text modifier to provide A case insensitive and starts with match of condition code text or condition code display text
patient reference The patientId of a subject to list family member items for
relationship token A valid relationship code of the family member history
status token A valid status code of the family member history
Request Headers  
X-Request-Id A unique id to for the request/response assigned by either client or server. The expected format is UUID. If the client doesn’t supply this id, it is expected that server SHALL assign one.

Response

The server returns matching FamilyMemberHistory instances in a Bundle that the logged-in user has access to. If no search criteria is provided, then all FamilyMemberHistory instances that the logged-in user has access to will be returned.

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Read

GET {API_URL}/v1/FamilyMemberHistory/{id}

This API interface enables the client to read an FamilyMemberHistory resource from MediRecords repository which is compliant with this FamilyMemberHistory.

Request Parameters  
id The logical id of the FamilyMemberHistory resource

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Create

POST {API_URL}/v1/FamilyMemberHistory

This API interface enables the client to create a FamilyMemberHistory resource in MediRecords repository which is compliant with this FamilyMemberHistory.

Request Parameters  
_format This parameter allows a client to override the accept header value when it is unable to set it correctly due to internal limitations (e.g. XSLT usage). the values xml, text/xml, application/xml, and application/fhir+xml SHALL be interpreted to mean the XML format, the codes json, application/json and application/fhir+json SHALL be interpreted to mean the JSON format. The _format parameter does not override the Content-Type header for the type of the body of a POST request
Request Headers  
Prefer The client can indicate how the response can be returned. return=minimal indicates that the client asks to return no body. return=representation indicates that the client asks to return the full resource. return=OperationOutcome indicates that the client asks server to return an OperationOutcome resource containing hints and warnings about the operation rather than the full resource
X-Request-Id A unique id to for the request/response assigned by either client or server. The expected format is UUID. If the client doesn’t supply this id, it is expected that server SHALL assign one.

Request Body

Request body that creates a new FamilyMemberHistory resource

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text  
201 Created The response to this depends on what is specified in “Prefer” header or what is server’s default behaviour. By default this returns the requested FamilyMemberHistory instance with the logical id populated in it.
400 Bad Request Resource could not be parsed or failed basic FHIR validation rules
401 Unauthorized  
403 Forbidden  
404 Not Found Resource type not supported, or not a FHIR end-point
409 Conflict  
422 Unprocessable Entity The proposed resource violated applicable FHIR profiles or server business rules.
500 Internal Server Error  

Update

PUT {API_URL}/v1/FamilyMemberHistory/{id}

This API interface enables the client to update a specific FamilyMemberHistory resource instance existed in MediRecords repository which is compliant with this FamilyMemberHistory.

Request Parameters  
id The logical id of the FamilyMemberHistory resource
Request Headers  
X-Request-Id A unique id to for the request/response assigned by either client or server. The expected format is UUID. If the client doesn’t supply this id, it is expected that server SHALL assign one.

Request Body

Request body that updates an existing FamilyMemberHistory record details

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
409 Conflict
422 Unprocessable Entity
500 Internal Server Error

Delete

DELETE {API_URL}/v1/FamilyMemberHistory/{id}

This API interface enables the client to delete a specific FamilyMemberHistory resource instance from MediRecords repository.

Request Parameters  
id The logical id of the FamilyMemberHistory resource
Request Headers  
X-Request-Id A unique id to for the request/response assigned by either client or server. The expected format is UUID. If the client doesn’t supply this id, it is expected that server SHALL assign one.

Response

In an error situation, server SHALL return OperationOutcome detailing the error with the appropriate HTTP Error code as follows.

Status Text
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Webhook

The following table provides the FHIR Webhook event types generated for the FamilyMemberHistory resource.

Hub Event Application Trigger Event  
family-member-history.created
coming soon
Occurs whenever a new family history record is created Example
family-member-history.updated
coming soon
Occurs whenever a family history record is updated  
Bundle
  FamilyMemberHistory (1)
  Patient (1)
  PractitionerRole (0..1)
  Practitioner (0..1)
  Organization (0..1)
   
family-member-history.deleted
coming soon
Occurs whenever a family history record is deleted
Bundle<br>
  request (1)
    url: DELETE FamilyMemberHistory/{id}