INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-Organization-1
The Organization resource represents the organisation that employs the healthcare professional.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
Summary
Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
- http://hl7.org/fhir/StructureDefinition/organization-period
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the value of value:system (Open at End)
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
  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 Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 Extension-CareConnect-MainLocation-1 | I | 0..1 | Reference() | Main location URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 |
| organization-period | I | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  identifier | ΣI | 0..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system |
  identifier:odsOrganisationCode | ΣI | 0..1 | Identifier | Organisation Data Service code |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
 identifier:odsSiteCode | ΣI | 0..1 | Identifier | ODS Site code to identify the organisation at site level |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | ΣI | 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 | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
| address | I | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
| partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| name | 0..1 | HumanName | A name associated with the contact | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
 period | Σ | 0..1 | Period | Time period when name was/is in use |
| 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 | |
| Documentation for this format | ||||
This structure is derived from Organization
Summary
Mandatory: 0 element (5 nested mandatory elements)
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
- http://hl7.org/fhir/StructureDefinition/organization-period
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the value of value:system (Open at End)
Differential View
This structure is derived from Organization
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | Organization | A grouping of people or organizations with a common purpose |
| 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 Binding: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| Extension-CareConnect-MainLocation-1 | I | 0..1 | Reference() | Main location URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 |
| organization-period | I | 0..1 | Period | Extension URL: http://hl7.org/fhir/StructureDefinition/organization-period |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | (Slice Definition) | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system |
| identifier:odsOrganisationCode | ΣI | 0..1 | Identifier | Organisation Data Service code |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| identifier:odsSiteCode | ΣI | 0..1 | Identifier | ODS Site code to identify the organisation at site level |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-site-code |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| type | Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | ΣI | 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 | I | 0..* | ContactPoint | A contact detail for the organization org-3: The telecom of an organization can never be of use 'home' |
| address | I | 0..* | Address | An address for the organization org-2: An address of an organization can never be of use 'home' |
| partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| name | 0..1 | HumanName | A name associated with the contact | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| text | Σ | 0..1 | string | Text representation of the full name |
| family | Σ | 1..1 | string | Family name (often called 'Surname') |
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| period | Σ | 0..1 | Period | Time period when name was/is in use |
| 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 | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Organization.language | extensible | Common Languages Max Binding: All Languages |
| Organization.identifier:odsOrganisationCode.use | required | IdentifierUse |
| Organization.identifier:odsOrganisationCode.type | extensible | Identifier Type Codes |
| Organization.identifier:odsSiteCode.use | required | IdentifierUse |
| Organization.identifier:odsSiteCode.type | extensible | Identifier Type Codes |
| Organization.type | example | OrganizationType |
| Organization.contact.purpose | extensible | ContactEntityType |
| Organization.contact.name.use | required | NameUse |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Organization | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| org-1 | Organization | The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| ele-1 | Organization.extension:mainLocation | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Organization.extension:mainLocation | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Organization.extension:organization-period | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ext-1 | Organization.extension:organization-period | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| ele-1 | Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |