GP Connect Get Record FHIR API Implementation Guide

GPConnect-Practitioner-1

The Practitioner resource represents the healthcare professional directly or indirectly involved in the provision of healthcare related services.

View Practitioner Resource Changes for a delta of changes made to the standard FHIR DSTU2 Practitioner resource for use within the GP Connect APIs.

NameCard.TypeDescription & Constraints
..PractitionerPractitionerThis Practitioner Resource is constrained for GP Connect requirements

...identifierA identifier for the person as this agent
Slice: Ordering: Unordered, Discriminator: system, Rules: Open at End

...identifier (SDS User ID)0..1IdentifierThe SDS identifier that uniquely identifies the person as this agent

....system1..1UriThe namespace for the identifier
Fixed Value http://fhir.nhs.net/Id/sds-user-id

....value1..1StringThe value that is unique
Example Value 1234567

...identifier (SDS Role Profile ID)0..*IdentifierThe SDS identifier that uniquely identifies the role profile of the person as this agent

....system1..1UriThe namespace for the identifier
Fixed Value http://fhir.nhs.net/Id/sds-role-profile-id

....value1..1StringThe value that is unique
Example Value PT1234

...active0..1BooleanWhether this practitioner's record is in active use
Default Value true

...name1..1HumanNameA name associated with the person/practitioner

....use0..1Codeusual | official | temp | nickname | anonymous | old | maiden
Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use)
Binding Strength Required

....family0..1StringFamily name for the practitioner (often called 'Surname')
Example Value Wood

....given0..*StringGiven name for the practitioner (not always 'first'). Includes middle names
Example Value Tom

....prefix0..*StringParts that come before the name, for example title
Example Value Dr.

....suffix0..*StringParts that come after the name

....period0..1PeriodTime period when name was/is in use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...telecom0..*ContactPointA contact detail for the practitioner

....system0..1Codephone | fax | email | url
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required
Example Value phone

....value0..1StringThe actual contact point details
Example Value 0113-333-1231

....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required
Example Value work

....period0..1PeriodTime period when the contact point was/is in use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...address0..*AddressWhere the practitioner can be found/visited

....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value work

....type0..1Codepostal | physical | both
Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

....line0..*StringStreet name, number etc
Example Value 13, Amber Street

....city0..1StringName of city, town etc where the GP resides.
Example Value Leeds

....district0..1StringDistrict name (aka county)
Example Value West Yorkshire

....postalCode0..1StringPostal code for area
Example Value LS20 1TV

....country0..1StringCountry (can be ISO 3166 3 letter code)
Example Value GBR

....period0..1PeriodTime period when address was/is in use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...gender0..1Codemale | female | other | unknown
Binding The gender of a person used for administrative purposes (http://fhir.nhs.net/ValueSet/administrative-gender-1)
Binding Strength Required
Example Value male

...practitionerRole0..*BackboneElementThe list of Roles/Organizations that the Practitioner is associated with

....managingOrganization0..1Reference (gpconnect-organization-1)The Organization where the Practitioner performs the roles associated

.....reference1..1StringRelative URL reference to the Organization resource
Example Value Organization/79600119-ebaf-4362-bb89-d473a33b1675

.....display0..1StringNarrative text for the resource
Example Value Wood Town GP Practice

....role0..1CodeableConceptRoles which this practitioner may perform
Binding The job role for an employee at an organization (http://fhir.nhs.net/ValueSet/sds-job-role-name-1)
Binding Strength Required

.....coding0..1CodingA code from the RBAC list of codes

......system1..1UriIdentity of the terminology system
Fixed Value http://fhir.nhs.net/ValueSet/sds-job-role-name-1

......code1..1CodeSymbol in syntax defined by the terminology system
Example Value R0050

......display1..1StringRepresentation defined by the terminology system
Example Value General Medical Practitioner

...communication0..*CodeableConceptA language the practitioner is able to use in patient communication
Binding A human language (http://fhir.nhs.net/ValueSet/human-language-1)
Binding Strength Required

....coding0..1CodingA code taken from the human language list of codes

.....system1..1UriIdentity of the terminology system
Fixed Value http://fhir.nhs.net/ValueSet/human-language-1

.....code1..1CodeSymbol in syntax defined by the terminology system
Example Value en

.....display1..1StringRepresentation defined by the terminology system
Example Value English

Path Name Binding Strength ValueSet
.Practitioner.name.use use Required http://hl7.org/fhir/ValueSet/name-use
.Practitioner.telecom.system system Required http://hl7.org/fhir/ValueSet/contact-point-system
.Practitioner.telecom.use use Required http://hl7.org/fhir/ValueSet/contact-point-use
.Practitioner.address.use use Required http://hl7.org/fhir/ValueSet/address-use
.Practitioner.address.type type Required http://hl7.org/fhir/ValueSet/address-type
.Practitioner.gender gender Required http://fhir.nhs.net/ValueSet/administrative-gender-1
.Practitioner.practitionerRole.role role Required http://fhir.nhs.net/ValueSet/sds-job-role-name-1
.Practitioner.qualification.code code Example http://hl7.org/fhir/ValueSet/anzsco-occupations
.Practitioner.communication communication Required http://fhir.nhs.net/ValueSet/human-language-1

GPConnect-Practitioner-1

Examples Description XML File JSON File
GP Practitioner Practitioner example - GP
Practitioner Practitioner example - Consultant
Practitioner-1a Practitioner example - Nurse