Organization resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
Organization: Implementation Guidance
Usage
The Organization resource is used to represent a grouping of people or organizations with a common purpose.
The Organization resource uses the CareConnectOrganization profile.
Detailed implementation guidance for an Organization resource in the $check-services operation is given below:
| Name | Cardinality | Type | FHIR/CareConnect Documentation | CDS Implementation Guidance |
|---|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact | |
meta |
0..1 |
Meta | Metadata about the resource | |
implicitRules |
0..1 |
uri | A set of rules under which this content was created | |
language |
0..1 |
code | Language of the resource content. Common Languages (Extensible but limited to All Languages) |
|
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation | |
contained |
0..* |
Resource | Contained, inline Resources | This SHOULD NOT be populated. |
extension (mainLocation) |
0..1 |
Extension | Main location URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 |
|
extension (organization-period) |
0..1 |
Extension | The date range that this organization should be considered available URL: http://hl7.org/fhir/stu3/StructureDefinition/organization-period |
|
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored | |
identifier |
0..* |
Identifier | Identifies this organization across multiple systems | |
identifier (odsOrganisationCode) |
0..1 |
Identifier | Organisation Data Service code | |
identifier (odsSiteCode) |
0..1 |
Identifier | ODS Site code to identify the organisation at site level | |
active |
0..1 |
boolean | Whether the organization's record is still in active use | |
type |
0..* |
CodeableConcept | Kind of organization OrganizationType (Example) |
|
name |
0..1 |
string | Name used for the organization | |
alias |
0..* |
string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom |
0..* |
ContactPoint | A contact detail for the organization + The telecom of an organization can never be of use 'home' |
|
address |
0..* |
Address | An address for the organization + An address of an organization can never be of use 'home' |
|
partOf |
0..1 |
Reference(Organization) | The organization of which this organization forms a part | |
contact |
0..* |
BackboneElement | Contact for the organization for a certain purpose | |
purpose |
0..1 |
CodeableConcept | The type of contact ContactEntityType (Extensible) |
|
name |
0..1 |
HumanName | A name associated with the contact | |
telecom |
0..* |
ContactPoint | Contact details (telephone, email, etc.) for a contact | |
address |
0..1 |
Address | Visiting or postal addresses for the contact | |
endpoint |
0..* |
Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | This SHOULD NOT be populated |
Organization Elements of note
endpoint
The technical endpoint must be specified at the HealthcareService.endpoint rather than in the Organization resource.
