GP Connect Get Record FHIR API Implementation Guide

GPConnect-Organization-1

This Organization resource represents the organisation that employs the healthcare practitioner.

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

NameCard.TypeDescription & Constraints
..OrganizationOrganizationThis Organization Resource is constrained for GP Connect requirements

...identifierIdentifies this organization across multiple systems
Slice: Ordering: Unordered, Discriminator: system, Rules: Open at End

...identifier (ODS Organisation Code)0..1IdentifierODS code to identify the organisation at organisation level

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

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

...identifier (ODS Site Code)0..*IdentifierODS Site code to identify the organisation at site level

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

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

...active0..1BooleanWhether the organization's record is still in active use
Default Value true

...type0..1CodeableConceptThe kind of organization that this is.
Binding Used to categorize the organization (http://hl7.org/fhir/ValueSet/organization-type)
Binding Strength Example

....coding0..1CodingA code taken from the organisation type list of codes.

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

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

.....display1..1StringRepresentation defined by the terminology system
Example Value Healthcare Provider

...name0..1StringName used for the organization associated with the ODS code
Example Value King's College Hospital

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

....system0..1Codephone | fax | email | pager | other
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-1234

....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..*AddressAn address for the organization

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

....text0..1StringText representation of the address
Example Value 1, Main Street, Leeds, West Yorkshire, LS1 3PO

....line0..*StringStreet name, number, direction & P.O. Box etc.
Example Value 1, Main Street

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

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

....postalCode0..1StringPostal code for area
Example Value LS1 3PO

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

...partOf0..1Reference (gpconnect-organization-1)The organization of which this organization forms a part

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...contact0..*BackboneElementContact for the organization for a certain purpose

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

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

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

.....family0..*StringFamily name (often called 'Surname')

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

.....prefix0..*StringParts that come before the name

.....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..*ContactPointContact details (telephone, email, etc.) for a contact

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

.....value0..1StringThe actual contact point details

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

.....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..1AddressVisiting or postal addresses for the contact

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

.....text0..1StringText representation of the address
Example Value 1, Main Street, Leeds, West Yorkshire, LS1 3PO

.....line0..*StringStreet name, number, direction & P.O. Box etc.
Example Value 1, Main Street

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

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

.....postalCode0..1StringPostal code for area
Example Value LS1 3PO

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

Path Name Binding Strength ValueSet
.Organization.type type Example http://hl7.org/fhir/ValueSet/organization-type
.Organization.telecom.system system Required http://hl7.org/fhir/ValueSet/contact-point-system
.Organization.telecom.use use Required http://hl7.org/fhir/ValueSet/contact-point-use
.Organization.address.use use Required http://hl7.org/fhir/ValueSet/address-use

GPConnect-Organization-1

Examples Description XML File JSON File
GP Organization GP Practice Example
Organization-1a Organization Example
Organization-1b Organization Example