type: "object"
description: "(Version 1 Deprecated) The PDS Change of GP event. You will receive this object if you subscribe to `pds-change-of-gp-1` events with an `application/json` format."
required:
  - "id"
  - "data"
  - "type"
  - "subject"
  - "source"
  - "time"
properties:
  id:
    type: "string"
    description: "UUID v4 format identifier."
  type:
    type: "string"
    description: "A unique string representing the event type."
  subject:
    type: "object"
    required:
      - "nhsNumber"
      - "familyName"
      - "dob"
    description: "The NHS patient who is the subject of the event."
    properties:
      nhsNumber:
        type: "string"
        description: "NHS Number validated in line with https://www.datadictionary.nhs.uk/attributes/nhs_number.html."
      familyName:
        type: "string"
        description: "Last name, capitalised"
      dob:
        type: "string"
        format: "date"
        description: "ISO-8601 is the required format. However, due to data quality inconsistencies in demographic records, both 'YYYY' and 'YYYY-MM' formats may also be seen. Refer to the [PDS FHIR API documentation](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir#get-/Patient) for further clarification on the accepted formats."
  source:
    type: "object"
    required:
      - "name"
      - "identifier"
    description: "Organisation responsible for publishing the patient-related event."
    properties:
      name:
        type: "string"
        description: "Organisation name"
      identifier:
        type: "object"
        required:
          - "system"
          - "value"
        description: "Must follow this identifier system: https://fhir.nhs.uk/Id/nhsSpineASID and provide the ASID Code as the value."
        properties:
          system:
            type: "string"
          value:
            type: "string"
  time:
    type: "string"
    format: "date-time"
    description: "The time at which the event is published. This must be a compliant RFC3339 datetime in line with the FHIR standard for [system instants](https://hl7.org/fhir/R4/datatypes.html#instant). This means it can have seconds or milliseconds precision."
  data:
    type: "object"
    required:
    - fullUrl
    - provenance
    - registrationEncounterCode
    - versionId
    properties:
      versionId:
        type: "string"
        description: "The versionId/ETAG identifies the version of the resource. The format should be a version identifier enclosed in quotes and preceded by 'W/'."
      fullUrl:
        type: "string"
        description: "The URL where the subscriber can retrieve the source of truth record for the patient or the full event payload."
      registrationEncounterCode:
        type: "string"
        description: |
          Numeric code that represents the type of GP registration that occurred. This field is only provided for the pds-change-of-gp-1 event type.
          The permitted codes are as follows:
          | Code | Type               | Description                                                                                                      |
          | ---- | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
          | 1    |  Birth             | At the time of registration, if the patient has been born in the last year then it is counted as such.           |
          | 2    |  First Acceptance  | Very rare scenario - patient is a UK National and has never previously been registered with an NHS GP Practice.  |
          | 3    |  Transfer In       | Accounts for the vast majority of registrations - a patient registers with a new GP Practice.                    |
          | 4    |  Immigrant         | A patient has moved to the UK and registers with a GP Practice .                                                 |
          | 6    |  Internal Transfer | A deprecated type. In [NHAIS](https://digital.nhs.uk/services/nhais) a transfer between two GP practices in the same NHAIS region is counted as this type within [PCRM](https://digital.nhs.uk/services/primary-care-registration-management) registrations are centralised and will be counted as Type 3 |
          | -    |  Blank             | Before a GP Registration is approved by Primary Care Support using NHAIS or PCRM, there is an initial GP-Links transaction sent by the GP Practice. This initial transaction will result in a event where the registration encounter code is set as an empty string. A subsequent event is created when the registration is processed, which this time includes a registration encounter code e.g. Type 3.  In the case of a GP Practice merge or split, the registration encounter code will also be an empty string. |
      provenance:
        type: "object"
        description: "The provenance describes which organisation was responsible for the creation of the event."
        required:
        - name
        - identifier
        properties:
          name:
            type: "string"
            description: "The name of the organisation responsible for the creating the event. This may be an empty string due to publisher data issues."
          identifier:
            type: "object"
            required:
            - "system"
            - "value"
            description: "Must follow this identifier system: https://fhir.nhs.uk/Id/nhsSpineASID and provide the ASID value and name of the system."
            properties:
                system:
                  type: "string"
                value:
                  type: "string"
example:
  id: "236a1d4a-5d69-4fa9-9c7f-e72bf505aa5b"
  type: "pds-change-of-gp-1"
  subject:
    dob: "2017-10-02"
    familyName: "DAWKINS"
    nhsNumber: "9912003888"
  source:
    name: "NHS DIGITAL"
    identifier:
      system: "https://fhir.nhs.uk/Id/nhsSpineASID"
      value: "477121000324"
  time: "2022-04-05T17:31:00.000Z"
  data:
    versionId: 'W/"2"'
    fullUrl: "https://int.api.service.nhs.uk/personal-demographics/FHIR/R4/Patient/9912003888"
    registrationEncounterCode: "3"
    provenance:
      name: "The GP Practice"
      identifier:
        system: "https://fhir.nhs.uk/Id/nhsSpineASID"
        value: "477121000323"