API R5 User Guide

This page provides guidance on interpreting the API specification using two sample cases. The samples below build upon the HL7 FHIR base resources (https://hl7.org/fhir/R5/resourcelist.html), showcasing the example variations that arise from extending the base resource.

#Sample 1:

AAC Master

This digram follows the standard structure in HL7 FHIR (referencing the base Organization). The sections below describe the variations, meaning they highlight the differences, constraints, and additional fields that extend the base Organization profile.

Main Structure

AAC Master

1. profile-Organization-put-asg-aac (Organization)

  • profile-Organization-put-asg-aac is simply a unique name for the profile designed to constrain the data elements, types, and cardinality of the Organization resource.
  • Organization is the actual resource being used in the FHIR JSON.

Fields

AAC Master

1. extension (1..1, Extension)

  • The extension field is required (1..1) and must follow the Extension structure.

  • organization-period (1..1, Extension(Period))

    • Represents an extension for the validity period of the organization.
    • url (1..1, Fixed Value, uri) – A fixed URL that defines this extension.
    • value [x] – Represents the period value.
      • A slice (e.g. valuePeriod) is used to define subsets of a repeating element in Slices(∑) with additional constraints.
      • (ALL Slices)
        • (This section is automatically generated and can be ignored. It indicates that multiple slices of the value[x] element may exist.)
      • valuePeriod (1..1, Period) – A time period with:
        • start (1..1, dateTime) – Start date.
        • end (0..1, dateTime) – End date.
AAC Master

2. identifier (∑, Identifier)

  • A slice (e.g. aac-center-id & uen) is used to define subsets of a repeating element in Slices(∑) with additional constraints.

  • This field can have multiple values, but each must match the defined slices

  • (ALL Slices)

    • (This section is automatically generated and can be ignored. It indicates that multiple slices of the value[x] element may exist.)

  • aac-center-id (1..1, Identifier)

    • Represents the AAC center ID of the organization.
    • system (1..1, Fixed Value, uri) – A fixed system URL for this identifier.
    • value (1..1, string) – The actual ID value.

  • uen (1..1, Identifier)

    • Represents the Unique Entity Number (UEN).
    • system (1..1, Fixed Value, uri) – A fixed system URL for UEN.
    • value (1..1, string) – The actual UEN value.

#Sample 2:

Resident List

This digram follows the standard structure in HL7 FHIR (referencing the base Parameters). The sections below describe the variations, meaning they highlight the differences, constraints, and additional fields that extend the base Parameters profile.

Main Structure

Resident List

1. profile-Parameter-get-asg-aac-senior-list (Parameters)

  • profile-Parameter-get-asg-aac-senior-list is simply a unique name for the profile designed to constrain the data elements, types, and cardinality of the Parameters resource.
  • Parameter is the actual resource being used in the FHIR JSON.

Fields

Resident List

1. parameter (∑, BackboneElement)

  • A slice (e.g. _count & _skip) is used to define subsets of a repeating element in Slices(∑) with additional constraints.

  • This field can have multiple parameters that can be included in the request, but each must match the defined slices

  • (ALL Slices)

    • (This section is automatically generated and can be ignored. It indicates that multiple slices of the parameter element may exist.)

  • _count (1..1, BackboneElement)

    • For pagination use, number of records to return.
    • name (1..1, Fixed Value, uri) – A fixed system URL for this parameter.
    • value[x] – Represents the integer value.
      • valueInteger (1..1, Integer) – number of records.

  • _skip (1..1, BackboneElement)

    • For pagination use, specify number of records to skip.
    • name (1..1, Fixed Value, uri) – A fixed system URL for this parameter.
    • value[x] – Represents the integer value.
      • valueInteger (1..1, Integer) – number of records to skip.