Page Comparison

PKB

FHIR

Notes

[[User.Public ID]]

N/A - cannot be set with this endpoint.

[[User.Title]]

Patient.name.prefix[0]

[[User.Given Name]]

Patient.name.given[0-x]

Required

[[User.Family Name]]

Patient.name.family

Required

[[Patient.Middle Names]]

N/A - cannot be set with this endpoint.

[[Patient.Address Line 1]]

Patient.address.line[0]

[[Patient.Address Line 2]]

Patient.address.line[1]

[[Patient.City]]

Patient.address.city

[[Patient.State]]

Patient.address.state

[[Patient.Country]]

Patient.address.country

[[Patient.Postal Code]]

Patient.address.postalCode

[[Patient.Date of Birth]]

Patient.birthDate

Required

[[Patient.Death Timestamp]]

The patient's deceased status can be set to true/false, but the timestamp cannot be set with this endpoint.

Patient.deceasedBoolean

[[Patient.Gender]]

Patient.gender

Required

[[Patient.Language]]

N/A - cannot be set with this endpoint.

[[Patient.Time Zone]]

N/A - cannot be set with this endpoint.

[[Patient.Skype ID]]

N/A - cannot be set with this endpoint.

[[Patient.Phone]]

• Patient.telecom[x]: ContactPoint

  • system = phone

  • value = [[Patient.Phone]]

[[Patient.Status]]

N/A - cannot be set with this endpoint.

[[Patient.Registered]]

N/A - cannot be set with this endpoint.

[[Patient.Sharing Disabled]]

N/A - cannot be set with this endpoint.

[[Patient.Access Frozen]]

N/A - cannot be set with this endpoint.

[[Patient.Entered Timestamp]]

N/A - cannot be set with this endpoint.

[[Patient.Persisted Timestamp]]

N/A - cannot be set with this endpoint.

[[Contact]]

For each [[Contact]]:

• Patient.telecom[x]: ContactPoint

  • system = "email"

  • value = [[Contact.Value]]

[[Contact.Is Primary]] = N/A - cannot be set with this endpoint
[[Contact.Is Confirmed]] = N/A - cannot be set with this endpoint

[[National ID]]

An NHS number, along with the verification status, must be provided. Other national ID types are not supported.

• url = "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1"

• valueCodeableConcept: CodeableConcept

  • coding: Coding

    • system = "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1"

    • code = "01"

A verified NHS number is required.

[[Local ID]]

N/A - cannot be set with this endpoint

[[Team Alias]]

See interaction description for more details.

• url = "http://fhir.patientsknowbest.com/structuredefinition/team-alias"

• valueString: [[team_alias_code]]

Team alias codes are configured on request by PKB.