Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: CareConnectOrganization1

Official URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1 Version: 0.1.0
Draft as of 2018-11-05 Computable Name: CareConnect-Organization-1

Copyright/Legal: Copyright © 2016 HL7 UK Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html

The Organization resource represents the organisation that employs the healthcare professional.

CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)Main location
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
.... identifier:odsOrganisationCode 0..1IdentifierOrganisation Data Service code
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:odsSiteCode 0..1IdentifierODS Site code to identify the organisation at site level
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... partOf 0..1Reference(CareConnect-Organization-1)The organization of which this organization forms a part
... contact
.... name
..... family 1..1stringFamily name (often called 'Surname')

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)Main location
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsOrganisationCode ΣC0..1IdentifierOrganisation Data Service code
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... partOf Σ0..1Reference(CareConnect-Organization-1)The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.userequiredIdentifierUse

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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()
dom-4errorOrganizationIf 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()
ele-1errorOrganization.extension:mainLocation, Organization.extension:organization-periodAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorOrganization.extension:mainLocation, Organization.extension:organization-periodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an id, and possibly more than one
: (identifier.count() + name.count()) > 0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)Main location
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsOrganisationCode ΣC0..1IdentifierOrganisation Data Service code
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization


... name ΣC0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom C0..*ContactPointA contact detail for the organization
... address C0..*AddressAn address for the organization
... partOf Σ0..1Reference(CareConnect-Organization-1)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party

.... name 0..1HumanNameA name associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorOrganization.extension:mainLocation, Organization.extension:organization-period, Organization.contactAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorOrganization.extension:mainLocation, Organization.extension:organization-periodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

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:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)Main location
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
.... identifier:odsOrganisationCode 0..1IdentifierOrganisation Data Service code
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:odsSiteCode 0..1IdentifierODS Site code to identify the organisation at site level
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value 1..1stringThe value that is unique
..... assigner 0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... partOf 0..1Reference(CareConnect-Organization-1)The organization of which this organization forms a part
... contact
.... name
..... family 1..1stringFamily name (often called 'Surname')

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)Main location
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsOrganisationCode ΣC0..1IdentifierOrganisation Data Service code
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... partOf Σ0..1Reference(CareConnect-Organization-1)The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.userequiredIdentifierUse

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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()
dom-4errorOrganizationIf 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()
ele-1errorOrganization.extension:mainLocation, Organization.extension:organization-periodAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorOrganization.extension:mainLocation, Organization.extension:organization-periodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an id, and possibly more than one
: (identifier.count() + name.count()) > 0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)Main location
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodExtension
URL: http://hl7.org/fhir/StructureDefinition/organization-period
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier ΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open At End by value:system
.... identifier:odsOrganisationCode ΣC0..1IdentifierOrganisation Data Service code
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
.... identifier:odsSiteCode ΣC0..1IdentifierODS Site code to identify the organisation at site level
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-site-code
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(CareConnect-Organization-1)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization


... name ΣC0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom C0..*ContactPointA contact detail for the organization
... address C0..*AddressAn address for the organization
... partOf Σ0..1Reference(CareConnect-Organization-1)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party

.... name 0..1HumanNameA name associated with the contact
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name

..... text Σ0..1stringText representation of the full name
..... family Σ1..1stringFamily name (often called 'Surname')
..... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
..... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
..... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
..... period Σ0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsOrganisationCode.typeextensibleIdentifier Type Codes
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.contact.purposeextensibleContactEntityType
Organization.contact.name.userequiredNameUse

Constraints

IdGradePath(s)DetailsRequirements
ele-1errorOrganization.extension:mainLocation, Organization.extension:organization-period, Organization.contactAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorOrganization.extension:mainLocation, Organization.extension:organization-periodMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

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:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of value:system (Open at End)

 

Other representations of profile: CSV, Excel, Schematron