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: InterweaveOrganization

Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-Organization Version: 0.1.0
Active as of 2024-03-08 Computable Name: InterweaveOrganization

Interweave Organization resource profile.

  Status: Active: Approved (STU)

Introduction

This profile sets minimum expectations for the Organization resource.

Organisation coverage and references

  • A Data Provider MUST offer Organisation FHIR resources to represent its own organisation(s)
  • When referencing an organisation then the “reference” (url of FHIR Resource) and “display” (name) MUST be populated
    • For an external organisation then the url could be either to an ad-hoc Contained Resource, or to the regional master organisation record
    • The “identifier” in the reference MAY be populated with the organisation’s ODS Code

Mandatory fields

The following fields are mandatory:

  1. Name - The name of the organisation

Must Support fields

In addition the following fields are “Must Support” - ie they must be populated if relevant and known:

  1. Identifier: ODS Organisation code - Must be populated where available. Almost all organisations in both Health and Social Care do have an ODS Code which both identifies the organisation and allows other details to be looked up from the master ODS records. However it is recognised that there may be some circumstances with new or smaller providers where it cannot be mandated.
  2. Type - The type of organisation, as classified by ODS
  3. Active - Essential if not active. Good practice to always populate anyway.
  4. Address - The organisation’s address. (Noting that the definitive address can always be looked up given the ODS code)

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Points of note include:

  • Other Identifiers -
    • ODS Site Code - Care Connect makes provision for an ODS Site code which may optionally be populated if relevant.
    • Local Id - As with most other resources, there is the option to include a local identifier. The wide use of ODS codes to uniquely identify an organisation makes it less important to also include a local id. However in cases where an ODS code does not exist then a local id MUST be provided instead to help identify the organisation.
  • Telecom - Can be populated if known - although the Location and Practitioner resources are likely to provide more specific and useful contact details

Discouraged or Removed fields

  • Extensions - Discouraged. Two extensions are defined by Care Connect, but do not appear to be vital for our usage here.
  • Part Of - Discouraged. We are expecting a simple, flat structure based on ODS codes. (Any modelling of ODS hierarchy could be done separately and does not need to be built into the resources).
  • Contact - Discouraged. These administrative contact details would need to be kept up-to-date, and do not appear particularly relevant to maintain or exchange.
  • Endpoint - Removed. Technical endpoints are captured elsewhere (ie via the Participant Registry)

Usage:

Formal Views of Profile Content

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

This structure is derived from CareConnect-Organization-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:mainLocation 0..1Extension-CareConnect-MainLocation-1DISCOURAGED
... extension:organization-period 0..1periodDISCOURAGED
... identifier:odsOrganisationCode S0..1IdentifierOrganisation Data Service code
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... identifier:localIdentifier 0..1IdentifierIdentifies this organization across multiple systems
.... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
.... value S1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
.... period 0..0
... active S0..1booleanWhether this organization is still active - must be both populated and understood if 'false'
... type S0..1CodeableConceptKind of organization
Binding: InterweaveOrganisationType (required)
.... coding 0..*CodingKind of organization (based on ODS organisation types)
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... name S1..1stringName used for the organization
... telecom 0..*ContactPointContact details of the location. (However contact details of Locations and Practitioners are probably more useful).
... address S0..1AddressAn address for the organization
.... use 0..1codeDISCOURAGED: Not really relevant here - it is just the current address of the location.
.... text 0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... district S0..1stringDistrict name (aka county)
.... postalCode S0..1stringPostal code for area
.... period 0..1PeriodDISCOURAGED: Preferably just relevant current details
... partOf 0..1Reference(CareConnect-Organization-1)DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
... contact 0..*BackboneElementDISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.typerequiredInterweaveOrganisationType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... mainLocation 0..1Reference(CareConnect-Location-1)DISCOURAGED
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodDISCOURAGED
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 SΣ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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value SΣ1..1stringThe value that is unique
Example General: 123456
.... 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
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... active ?!SΣ0..1booleanWhether this organization is still active - must be both populated and understood if 'false'
... type SΣ0..1CodeableConceptKind of organization
Binding: InterweaveOrganisationType (required)
.... coding Σ0..*CodingKind of organization (based on ODS organisation types)
..... system Σ1..1uriIdentity of the terminology system
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
... name SΣC1..1stringName used for the organization
... telecom C0..*ContactPointContact details of the location. (However contact details of Locations and Practitioners are probably more useful).
... address SC0..1AddressAn address for the organization
.... use ?!Σ0..1codeDISCOURAGED: Not really relevant here - it is just the current address of the location.
Binding: AddressUse (required): The use of an address


Example General: home
.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... period Σ0..1PeriodDISCOURAGED: Preferably just relevant current details
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(CareConnect-Organization-1)DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
... contact 0..*BackboneElementDISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:localIdentifier.userequiredIdentifierUse
Organization.typerequiredInterweaveOrganisationType
Organization.address.userequiredAddressUse

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-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-1errorOrganizationThe organization SHALL at least have a name or an id, and possibly more than one
: (identifier.count() + name.count()) > 0
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)DISCOURAGED
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodDISCOURAGED
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 SΣ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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value SΣ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)
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ0..1booleanWhether this organization is still active - must be both populated and understood if 'false'
... type SΣ0..1CodeableConceptKind of organization
Binding: InterweaveOrganisationType (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingKind of organization (based on ODS organisation types)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name SΣC1..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..*ContactPointContact details of the location. (However contact details of Locations and Practitioners are probably more useful).
... address SC0..1AddressAn address for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeDISCOURAGED: Not really relevant here - it is just the current address of the location.
Binding: AddressUse (required): The use of an address


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal)


Example General: both
.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodDISCOURAGED: Preferably just relevant current details
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(CareConnect-Organization-1)DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
... contact 0..*BackboneElementDISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
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.identifier:localIdentifier.userequiredIdentifierUse
Organization.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Organization.typerequiredInterweaveOrganisationType
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
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 CareConnect-Organization-1

Summary

Mandatory: 1 element (11 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element Organization.meta.tag is sliced based on the value of value:system

Differential View

This structure is derived from CareConnect-Organization-1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id S0..1idLogical id of this artifact
... meta
.... versionId S0..1idVersion specific identifier
.... lastUpdated S0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile S0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security 0..*CodingDISCOURAGED - may not be honoured by Data Consumers
.... Slices for tag 0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
..... tag:Source S0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code S1..1codeThe Data Provider Id of the system supplying the data
...... display S1..1stringName of the system supplying the data
..... tag:Provenance S0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code S1..1codeThe ODS Code of the organisation responsible for the data
...... display S1..1stringName of the organisation supplying the data
... implicitRules 0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... extension:mainLocation 0..1Extension-CareConnect-MainLocation-1DISCOURAGED
... extension:organization-period 0..1periodDISCOURAGED
... identifier:odsOrganisationCode S0..1IdentifierOrganisation Data Service code
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... identifier:localIdentifier 0..1IdentifierIdentifies this organization across multiple systems
.... system S1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
.... value S1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
.... period 0..0
... active S0..1booleanWhether this organization is still active - must be both populated and understood if 'false'
... type S0..1CodeableConceptKind of organization
Binding: InterweaveOrganisationType (required)
.... coding 0..*CodingKind of organization (based on ODS organisation types)
..... system 1..1uriIdentity of the terminology system
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
... name S1..1stringName used for the organization
... telecom 0..*ContactPointContact details of the location. (However contact details of Locations and Practitioners are probably more useful).
... address S0..1AddressAn address for the organization
.... use 0..1codeDISCOURAGED: Not really relevant here - it is just the current address of the location.
.... text 0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
.... line S0..*stringStreet name, number, direction & P.O. Box etc.
.... city S0..1stringName of city, town etc.
.... district S0..1stringDistrict name (aka county)
.... postalCode S0..1stringPostal code for area
.... period 0..1PeriodDISCOURAGED: Preferably just relevant current details
... partOf 0..1Reference(CareConnect-Organization-1)DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
... contact 0..*BackboneElementDISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Organization.typerequiredInterweaveOrganisationType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... mainLocation 0..1Reference(CareConnect-Location-1)DISCOURAGED
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodDISCOURAGED
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 SΣ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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value SΣ1..1stringThe value that is unique
Example General: 123456
.... 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
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
... active ?!SΣ0..1booleanWhether this organization is still active - must be both populated and understood if 'false'
... type SΣ0..1CodeableConceptKind of organization
Binding: InterweaveOrganisationType (required)
.... coding Σ0..*CodingKind of organization (based on ODS organisation types)
..... system Σ1..1uriIdentity of the terminology system
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
... name SΣC1..1stringName used for the organization
... telecom C0..*ContactPointContact details of the location. (However contact details of Locations and Practitioners are probably more useful).
... address SC0..1AddressAn address for the organization
.... use ?!Σ0..1codeDISCOURAGED: Not really relevant here - it is just the current address of the location.
Binding: AddressUse (required): The use of an address


Example General: home
.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... period Σ0..1PeriodDISCOURAGED: Preferably just relevant current details
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(CareConnect-Organization-1)DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
... contact 0..*BackboneElementDISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
Organization.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:odsOrganisationCode.userequiredIdentifierUse
Organization.identifier:odsSiteCode.userequiredIdentifierUse
Organization.identifier:localIdentifier.userequiredIdentifierUse
Organization.typerequiredInterweaveOrganisationType
Organization.address.userequiredAddressUse

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-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-1errorOrganizationThe organization SHALL at least have a name or an id, and possibly more than one
: (identifier.count() + name.count()) > 0
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*CareConnect-Organization-1A grouping of people or organizations with a common purpose
... id SΣ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SΣ0..1idVersion specific identifier
.... lastUpdated SΣ0..1instantMANDATORY except in Contained Resources. When the resource version last changed.
.... profile SΣ0..*uriProfiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
.... security Σ0..*CodingDISCOURAGED - may not be honoured by Data Consumers
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... Slices for tag Σ0..*CodingTags applied to this resource
Slice: Unordered, Open by value:system
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


..... tag:Source SΣ0..1CodingMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Source
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe Data Provider Id of the system supplying the data
...... display SΣ1..1stringName of the system supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... tag:Provenance SΣ0..1CodingMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
Binding: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://yhcr.nhs.uk/Provenance
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeThe ODS Code of the organisation responsible for the data
...... display SΣ1..1stringName of the organisation supplying the data
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriDISCOURAGED - may not be honoured by Data Consumers
... text 0..1NarrativeDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainLocation 0..1Reference(CareConnect-Location-1)DISCOURAGED
URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1
... organization-period 0..1PeriodDISCOURAGED
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 SΣ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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code
..... value SΣ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)
.... identifier:localIdentifier ΣC0..1IdentifierIdentifies this organization across multiple systems
..... 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 SΣ1..1uriThe namespace for the identifier value
Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier
..... value SΣ1..1stringThe Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
Example General: 123456
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ0..1booleanWhether this organization is still active - must be both populated and understood if 'false'
... type SΣ0..1CodeableConceptKind of organization
Binding: InterweaveOrganisationType (required)
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingKind of organization (based on ODS organisation types)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ1..1codeSymbol in syntax defined by the system
..... display Σ1..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... name SΣC1..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..*ContactPointContact details of the location. (However contact details of Locations and Practitioners are probably more useful).
... address SC0..1AddressAn address for the organization
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeDISCOURAGED: Not really relevant here - it is just the current address of the location.
Binding: AddressUse (required): The use of an address


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal)


Example General: both
.... text Σ0..1stringDISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... district SΣ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode SΣ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodDISCOURAGED: Preferably just relevant current details
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(CareConnect-Organization-1)DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree
... contact 0..*BackboneElementDISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful
.... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.meta.securityextensibleAll Security Labels
Organization.meta.tagexampleCommon Tags
Organization.meta.tag:SourceexampleCommon Tags
Organization.meta.tag:ProvenanceexampleCommon Tags
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.identifier:localIdentifier.userequiredIdentifierUse
Organization.identifier:localIdentifier.typeextensibleIdentifier Type Codes
Organization.typerequiredInterweaveOrganisationType
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
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 CareConnect-Organization-1

Summary

Mandatory: 1 element (11 nested mandatory elements)
Must-Support: 23 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element Organization.meta.tag is sliced based on the value of value:system

 

Other representations of profile: CSV, Excel, Schematron