Usage scenarios

The following are supported usage scenarios for this profile:

• Query for lists associated with a patient
• Record or update an list associated with a patient

Comparison with other national and international specifications

No equivalent International Patient Access, International Patient Summary or US Core profile.

Profile specific implementation guidance

• When a related person is the author of the list, the Author as a RelatedPerson extension is used and List.source is not included.
• When constructing a medicine list see the AU Medicine List profile in AU Base.

Specific feedback is sought on the set of lists and associated codes to be supported in Australia.

Composition, DocumentReference, DiagnosticReport, and List resources support support the exchange of clinical notes. Specific feedback is sought on resource selection to form agreement on the clinical notes that SHOULD be exposed via List.

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHOULD support fetching a List using the _id search parameter:
   • SHALL support these _revinclude parameters: Provenance:target

   GET [base]/List/[id] or GET [base]/List?_id=[id]

   Example:

   1. GET [base]/List/98767
   2. GET [base]/List?_id=98767

   Implementation Notes: Fetches a single List (how to search by the logical id of the resource)

2. SHALL support searching using the patient search parameter:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

   GET [base]/List?patient={Type/}[id] or optionally GET [base]/List?patient.identifier=[system|][code]

   Example:

   1. GET [base]/List?patient=5678
   2. GET [base]/List?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
   3. GET [base]/List?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

   Implementation Notes: Fetches a bundle of all List resources for the specified patient (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameters and search parameter combinations SHOULD be supported:

1. SHOULD support searching using the identifier search parameter:
   • SHALL support these _revinclude parameters: Provenance:target

   GET [base]/List?identifier={system|}[code]

   Example:

   1. GET [base]/List?identifier=http://laboratory.example.org|1032333
   2. GET [base]/List?identifier=http://laboratory.example.org|1032333&_revinclude=Provenance:target

   Implementation Notes: Fetches a bundle containing any List resources matching the identifier (how to search by token)

2. SHOULD support searching using the combination of the patient and code search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
   • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

   GET [base]/List?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

   Example:

   1. GET [base]/List?patient=5678&code=http://loinc.org|10160-0,http://loinc.org|11369-6

   Implementation Notes: Fetches a bundle of all List resources for the specified patient and list code(s). The List code parameter searches List.code only. (how to search by reference and how to search by token)

3. SHOULD support searching using the combination of the patient and code and date search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
   • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
   • SHALL support these date comparators: gt,lt,ge,le
   • SHOULD support multipleAnd search on date (e.g.date=[date]&date=[date]]&...)

   GET [base]/List?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}

   Example:

   1. GET [base]/List?patient=5678&code=http://loinc.org|10160-0,http://loinc.org|11369-6&date=ge2020-01-01T00:00:00Z
   2. GET [base]/List?patient.identifier=http://example.org/fhir/mrn|12345&code=http://loinc.org|10160-0,http://loinc.org|11369-6&date=ge2020-01-01T00:00:00Z

   Implementation Notes: Fetches a bundle of all List resources for the specified patient and date and report code(s) (how to search by reference and how to search by token and how to search by date)

4. SHOULD support searching using the combination of the patient and status search parameters:
   • SHALL support these _revinclude parameters: Provenance:target
   • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
   • SHALL support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

   GET [base]/List?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

   Example:

   1. GET [base]/List?patient=5678&status=final

   Implementation Notes: Fetches a bundle of all List resources for the specified patient and status (how to search by reference and how to search by token)