Clinical | Family Member History

Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

Important: This site is under active development by NHS Digital on behalf of INTEROPen and is intended to provide all the technical resources you need to successfully develop the Care Connect APIs. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.

0. References

HL7 UK | Care Connect Profile:
FamilyMemberHistory

HL7 FHIR Resource:
FamilyMemberHistory

User Stories:
User Stories

Read

GET [baseUrl]/FamilyMemberHistory/[id]

Return a single FamilyMemberHistory for the specified id

Search Parameters

GET [baseUrl]/FamilyMemberHistory?[searchParameters]

Fetches a bundle of all FamilyMemberHistory resources for the specified patient.

This implementation guide outlines some suggested search parameters for the FamilyMemberHistory resource in the table below. To be conformant, provider systems are required to implement all of the SHALL parameters. Provider systems may implement the full list of search parameters for the FamilyMemberHistory resource (HL7 FHIR STU3 FamilyMemberHistory).

Note: Details on the Search Parameters selection and feedback process can be found here Search Parameters

Name	Type	Description	Conformance	Path
`date`	`date`	Obtained date/time. If the obtained element is a period, a date that falls in the period	Y	FamilyMemberHistory.date
`gender`	`token`	A search by a gender code of a family member		FamilyMemberHistory.gender
`patient`	`reference`	The identity of a subject to list family member history items for	Y	FamilyMemberHistory.patient (Patient)

date

GET [baseUrl]/FamilyMemberHistory?patient=[id]&date=[date]

See date for details on this parameter. ‘date’ can be used multiple times as a search parameter

GET [baseUrl]/FamilyMemberHistory?patient=1&date=ge2010-01-01&date=le2011-12-31

Return all FamilyMemberHistory resources that have a date greater than or equal to 1st Jan 2010, a date less than or equal to 31st Dec 2011 and Patient with a logical id of 1.

patient

See reference for details on this parameter. The patient parameter can be used two ways:

GET [baseUrl]/FamilyMemberHistory?patient=[id]

This SHALL be supported for all endpoint provider systems.

id is the logical id of the patient on the server which can be obtained by a Patient resource query.

GET [baseUrl]/FamilyMemberHistory?patient=42

Return all FamilyMemberHistory resources for Patients with a logical id of 42

GET [baseUrl]/FamilyMemberHistory?patient.identifier=[system]|[code]

This SHOULD be supported by middleware systems (e.g. enterprise application integration (EAI) and the enterprise service bus (ESB)) and MAY be supported for endpoint provider systems.

system is a uniform resource identifier which defines which CodeSystem the identifer belongs to. For NHS Number this would be https://fhir.nhs.uk/Id/nhs-number and code would be the NHS Number.

GET [baseUrl]/FamilyMemberHistory?patient.identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210

Return all FamilyMemberHistory resources for Patients with a NHS Number of 9876543210

Tags: