Technical Patterns

The Patient Flag API and all it's sub-domains use the FHIR REST paradigm.

FHIR REST

Implementations SHOULD provide capability to offer and consume RESTful interactions to allow an efficient implementation of the required API.

Implementations SHALL provide capability to offer and consume basic CRUD (create, read/search, update, delete) interactions via http.

Implementations SHALL provide capability to offer and consume additional FHIR REST functionality, e.g. Transaction support, Conditional Update etc. as required in the relevant, specific implementation guidance in play for a given integration.

Implementers SHALL be aware of and compliant with standard FHIR REST functionality defined in the HL7 FHIR Specification on topics:

and in using:

Capability Statements

Applications/systems offering an API SHALL document resources and interactions supported via a CapabilityStatement resource available as per CapabilityStatement and Conformance Rules pages of the FHIR (Release 4) Specification.

Applications/systems integrating with an API SHALL document resources and interactions supported via a CapabilityStatement resource available as per CapabilityStatement and Conformance Rules pages of the FHIR (Release 4) Specification.

Specific Implementations

Implementations SHALL provide all functionality additionally required by their specification and/or Implementation guidance. This may constitute:

  • Standard integration requirements regarding authorisation, logging etc.
  • Additional FHIR constraints
  • Additional non-FHIR business rules and process requirements

Reasonable Adjustments

Reasonable Adjustments data model includes additional detail resources that record: