GP Connect Get Record FHIR API Implementation Guide

GPConnect-Patient-1

The Patient resource carries the patient demographic details.

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

NameCard.TypeDescription & Constraints
..PatientPatientThis Patient resource is constrained for the GP Connect API interaction requirements

...identifierAn identifier for this patient
Slice: Ordering: Ordered, Discriminator: system, Rules: Open at End

...identifier (NHSNumber)1..1IdentifierAn NHS Number identifier for this patient

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

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

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

...name0..*HumanNameA name associated with the patient

....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
Example Value usual

....text0..1StringText representation of the full name

....family0..1StringFamily name (often called 'Surname')
Example Value Taylor

....given0..1StringGiven names (not always 'first'). Includes middle names
Example Value Sally

....prefix0..*StringParts that come before the name
Example Value Mrs

....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 individual

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

....value1..1StringThe actual contact point details
Example Value 0113-245-1919

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

....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

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

...birthDate0..1DateThe date of birth for the patient

...deceased[x] (deceasedDateTime)0..1DateTimeIndicates the deceased date and/or time of the patient

...address0..*AddressAddress details for the patient

....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 home

....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

....text0..1StringText representation of the address
Example Value 42 Grove Street, Overtown, West Yorkshire, LS21 1PF

....line0..*StringStreet name, number etc.
Example Value 42, Grove Street

....city0..1StringName of city, town etc.
Example Value Overtown

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

....postalCode0..1StringPostal code for area
Example Value LS21 1PF

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

....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

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

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

...maritalStatus0..1CodeableConceptMarital (civil) status of a patient
Binding The domestic partnership status of a person. (http://hl7.org/fhir/ValueSet/marital-status)
Binding Strength Required

....coding0..1CodingA code taken from the marital status list of codes.

.....system1..1UriIdentity of the terminology system
Fixed Value http://hl7.org/fhir/ValueSet/marital-status

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

.....display1..1StringRepresentation defined by the system
Example Value Married

...multipleBirth[x]0..1BooleanIndicates whether the patient is part of a multiple

...contact0..*BackboneElementA contact (e.g. guardian, partner, friend) for the patient

....relationship0..*CodeableConceptThe kind of relationship to the patient
Binding The nature of the relationship between a patient and a contact person for that patient. (http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1)
Binding Strength Required

.....coding0..1CodingA code taken from the CDA Person Relationship Type list of codes.

......system1..1UriIdentity of the terminology system
Fixed Value http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1

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

......display1..1StringRepresentation defined by the system
Example Value Daughter

....name0..1HumanNameA name associated with the contact person.

.....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
Example Value usual

.....family0..1StringFamily name (often called 'Surname')
Example Value Taylor

.....given0..*StringGiven names (not always 'first'). Includes middle names
Example Value Ann

.....prefix0..*StringParts that come before the name
Example Value Miss

.....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 contact person

.....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-245-0909

.....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 home

.....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..1AddressAddress for the contact person.

.....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 home

.....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

.....text0..1StringText representation of the address
Example Value 120, Grove Street, Overtown, West Yorkshire, LS21 1PT

.....line0..*StringStreet name, number etc
Example Value 120, Grove Street

.....city0..1StringName of city, town etc.
Example Value Overtown

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

.....postalCode0..1StringPostal code for area
Example Value LS21 1PT

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

.....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

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

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

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

....organization0..1Reference (gpconnect-organization-1)Organization that is associated with the contact for the patient

.....reference0..1StringRelative URL reference to the Organization resource

.....display0..1StringNarrative text for the resource

....period0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient

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

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

...communication0..*BackboneElementPatient communication preferences

....language1..1CodeableConceptLanguages which may be used to communicate with the patient about his or her health
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 system
Example Value en

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

....preferred0..1BooleanLanguage preference indicator.

...careProvider0..1Reference (gpconnect-practitioner-1)Patient's nominated care provider

...managingOrganization0..1Reference (gpconnect-organization-1)Organization that is the custodian of the patient record

....reference0..1StringRelative URL reference to the Organization resource

....display0..1StringNarrative text for the resource

GPConnect-Patient-1

Examples Description XML File JSON File
Patient NHS Patient example