Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


GP Connect API - Access Document 1.0.0-beta release notes

GP Connect API - Access Document 1.0.0-beta released on 30th September 2019

Introduction

The GP Connect API - Access Document 1.0.0-beta release introduces the Access Document capability. This specification is being published separately to the other capabilities and looks purely at documents.

Overview

Getting started

Affects  Overview

Description:

  • page rewrite as other capabilities have been removed

Pages changed:

Development

General API guidance

Affects  Development

Description:

  • Service Root URL versioning - The [PROVIDER_ROUTING_SEGMENT] is now mandatory and is used to differentiate between logical FHIR servers that are exposed by providers
  • The example service root URL has been updated to use a documents specific URL segment

Pages changed:

Design approach

API principles

Affects  Design approach

Description:

  • The first principle has been updated to state that this capability is exposed in it’s own FHIR server.

Pages changed:

Spine integration

Affects  Integrate with spine

Description:

  • Interaction ids have been added for the query and retrieval APIs
  • interaction ids have been added for the patient, organisation and practitioner APIs

Pages changed:

Access Record Documents

Overview

Use cases

API

Affects  Access Documents

Description:

  • Restful APIs have been defined for querying and retrieving documents
  • Restful APIs have been added for patient, organisation and practitioner
  • Consumer sessions page has been added to illustrate how APIs are used

Pages changed:


All content is available under the Open Government Licence v3.0, except where otherwise stated