Interweave Implementation Guide
0.1.0 - ci-build
Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the R4 profiles here.
Official URL: https://fhir.yhcr.nhs.uk/StructureDefinition/Interweave-Organization | Version: 0.1.0 | |||
Active as of 2024-07-17 | Computable Name: InterweaveOrganization |
Interweave Organization resource profile.
Status: Active: Approved (STU)
This profile sets minimum expectations for the Organization resource.
The following fields are mandatory:
In addition the following fields are “Must Support” - ie they must be populated if relevant and known:
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:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareConnect-Organization-1
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | CareConnect-Organization-1 | A grouping of people or organizations with a common purpose | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | |
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | |
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - 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..1 | Extension-CareConnect-MainLocation-1 | DISCOURAGED | |
extension:organization-period | 0..1 | period | DISCOURAGED | |
identifier:odsOrganisationCode | S | 0..1 | Identifier | Organisation Data Service code |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier:localIdentifier | 0..1 | Identifier | Identifies this organization across multiple systems | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier |
value | S | 1..1 | string | The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique |
period | 0..0 | |||
active | S | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' |
type | S | 0..1 | CodeableConcept | Kind of organization Binding: InterweaveOrganisationType (required) |
coding | 0..* | Coding | Kind of organization (based on ODS organisation types) | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
name | S | 1..1 | string | Name used for the organization |
telecom | 0..* | ContactPoint | Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). | |
address | S | 0..1 | Address | An address for the organization |
use | 0..1 | code | DISCOURAGED: Not really relevant here - it is just the current address of the location. | |
text | 0..1 | string | DISCOURAGED: 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 | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
district | S | 0..1 | string | District name (aka county) |
postalCode | S | 0..1 | string | Postal code for area |
period | 0..1 | Period | DISCOURAGED: Preferably just relevant current details | |
partOf | 0..1 | Reference(CareConnect-Organization-1) | DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree | |
contact | 0..* | BackboneElement | DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful | |
endpoint | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Organization.type | required | InterweaveOrganisationType |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | CareConnect-Organization-1 | A grouping of people or organizations with a common purpose | ||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - 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..* | Coding | Tags 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..1 | Coding | MANDATORY 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..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY 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..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - 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..1 | Reference(CareConnect-Location-1) | DISCOURAGED URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 | |||||
organization-period | 0..1 | Period | DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system | ||||
identifier:odsOrganisationCode | SΣC | 0..1 | Identifier | Organisation Data Service code | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:odsSiteCode | ΣC | 0..1 | Identifier | ODS Site code to identify the organisation at site level | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
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 | ||||
identifier:localIdentifier | ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier | ||||
value | SΣ | 1..1 | string | The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
active | ?!SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
type | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: InterweaveOrganisationType (required) | ||||
coding | Σ | 0..* | Coding | Kind of organization (based on ODS organisation types) | ||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
telecom | C | 0..* | ContactPoint | Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). | ||||
address | SC | 0..1 | Address | An address for the organization | ||||
use | ?!Σ | 0..1 | code | DISCOURAGED: 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..1 | string | DISCOURAGED: 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..* | string | Street 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..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | SΣ | 0..1 | string | District name (aka county) Example General: Madison | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
period | Σ | 0..1 | Period | DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree | ||||
contact | 0..* | BackboneElement | DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | Common Tags | ||||
Organization.meta.tag:Source | example | Common Tags | ||||
Organization.meta.tag:Provenance | example | Common Tags | ||||
Organization.language | extensible | Common Languages
| ||||
Organization.identifier:odsOrganisationCode.use | required | IdentifierUse | ||||
Organization.identifier:odsSiteCode.use | required | IdentifierUse | ||||
Organization.identifier:localIdentifier.use | required | IdentifierUse | ||||
Organization.type | required | InterweaveOrganisationType | ||||
Organization.address.use | required | AddressUse |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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() | |
dom-4 | error | 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() | |
ele-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period, Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | CareConnect-Organization-1 | A grouping of people or organizations with a common purpose | ||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - 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..* | Coding | Tags 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..1 | Coding | MANDATORY 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - 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..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
mainLocation | 0..1 | Reference(CareConnect-Location-1) | DISCOURAGED URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 | |||||
organization-period | 0..1 | Period | DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system | ||||
identifier:odsOrganisationCode | SΣC | 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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code | ||||
value | SΣ | 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 | ΣC | 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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..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) | ||||
identifier:localIdentifier | ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier | ||||
value | SΣ | 1..1 | string | The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
type | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: InterweaveOrganisationType (required) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Kind of organization (based on ODS organisation types) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | SΣC | 1..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 | C | 0..* | ContactPoint | Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). | ||||
address | SC | 0..1 | Address | An address for the organization | ||||
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 | DISCOURAGED: 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..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal) Example General: both | ||||
text | Σ | 0..1 | string | DISCOURAGED: 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..* | string | Street 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..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | SΣ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree | ||||
contact | 0..* | BackboneElement | DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful | |||||
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): The purpose for which you would contact a contact party | |||||
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): The use of a human name | ||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | Common Tags | ||||
Organization.meta.tag:Source | example | Common Tags | ||||
Organization.meta.tag:Provenance | example | Common Tags | ||||
Organization.language | extensible | Common 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.identifier:localIdentifier.use | required | IdentifierUse | ||||
Organization.identifier:localIdentifier.type | extensible | Identifier Type Codes | ||||
Organization.type | required | InterweaveOrganisationType | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.contact.purpose | extensible | ContactEntityType | ||||
Organization.contact.name.use | required | NameUse |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period, Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom | The 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:
Differential View
This structure is derived from CareConnect-Organization-1
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | CareConnect-Organization-1 | A grouping of people or organizations with a common purpose | |
id | S | 0..1 | id | Logical id of this artifact |
meta | ||||
versionId | S | 0..1 | id | Version specific identifier |
lastUpdated | S | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. |
profile | S | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile |
security | 0..* | Coding | DISCOURAGED - may not be honoured by Data Consumers | |
Slices for tag | 0..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:system | |
tag:Source | S | 0..1 | Coding | MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | |
code | S | 1..1 | code | The Data Provider Id of the system supplying the data |
display | S | 1..1 | string | Name of the system supplying the data |
tag:Provenance | S | 0..1 | Coding | MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data |
system | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | |
code | S | 1..1 | code | The ODS Code of the organisation responsible for the data |
display | S | 1..1 | string | Name of the organisation supplying the data |
implicitRules | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | |
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) | |
text | 0..1 | Narrative | DISCOURAGED - 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..1 | Extension-CareConnect-MainLocation-1 | DISCOURAGED | |
extension:organization-period | 0..1 | period | DISCOURAGED | |
identifier:odsOrganisationCode | S | 0..1 | Identifier | Organisation Data Service code |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
identifier:localIdentifier | 0..1 | Identifier | Identifies this organization across multiple systems | |
system | S | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier |
value | S | 1..1 | string | The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique |
period | 0..0 | |||
active | S | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' |
type | S | 0..1 | CodeableConcept | Kind of organization Binding: InterweaveOrganisationType (required) |
coding | 0..* | Coding | Kind of organization (based on ODS organisation types) | |
system | 1..1 | uri | Identity of the terminology system | |
code | 1..1 | code | Symbol in syntax defined by the system | |
display | 1..1 | string | Representation defined by the system | |
name | S | 1..1 | string | Name used for the organization |
telecom | 0..* | ContactPoint | Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). | |
address | S | 0..1 | Address | An address for the organization |
use | 0..1 | code | DISCOURAGED: Not really relevant here - it is just the current address of the location. | |
text | 0..1 | string | DISCOURAGED: 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 | S | 0..* | string | Street name, number, direction & P.O. Box etc. |
city | S | 0..1 | string | Name of city, town etc. |
district | S | 0..1 | string | District name (aka county) |
postalCode | S | 0..1 | string | Postal code for area |
period | 0..1 | Period | DISCOURAGED: Preferably just relevant current details | |
partOf | 0..1 | Reference(CareConnect-Organization-1) | DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree | |
contact | 0..* | BackboneElement | DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful | |
endpoint | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet |
Organization.type | required | InterweaveOrganisationType |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | CareConnect-Organization-1 | A grouping of people or organizations with a common purpose | ||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - 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..* | Coding | Tags 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..1 | Coding | MANDATORY 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..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY 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..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - 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..1 | Reference(CareConnect-Location-1) | DISCOURAGED URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 | |||||
organization-period | 0..1 | Period | DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system | ||||
identifier:odsOrganisationCode | SΣC | 0..1 | Identifier | Organisation Data Service code | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
identifier:odsSiteCode | ΣC | 0..1 | Identifier | ODS Site code to identify the organisation at site level | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
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 | ||||
identifier:localIdentifier | ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier | ||||
value | SΣ | 1..1 | string | The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
active | ?!SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
type | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: InterweaveOrganisationType (required) | ||||
coding | Σ | 0..* | Coding | Kind of organization (based on ODS organisation types) | ||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
telecom | C | 0..* | ContactPoint | Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). | ||||
address | SC | 0..1 | Address | An address for the organization | ||||
use | ?!Σ | 0..1 | code | DISCOURAGED: 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..1 | string | DISCOURAGED: 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..* | string | Street 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..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | SΣ | 0..1 | string | District name (aka county) Example General: Madison | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
period | Σ | 0..1 | Period | DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree | ||||
contact | 0..* | BackboneElement | DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | Common Tags | ||||
Organization.meta.tag:Source | example | Common Tags | ||||
Organization.meta.tag:Provenance | example | Common Tags | ||||
Organization.language | extensible | Common Languages
| ||||
Organization.identifier:odsOrganisationCode.use | required | IdentifierUse | ||||
Organization.identifier:odsSiteCode.use | required | IdentifierUse | ||||
Organization.identifier:localIdentifier.use | required | IdentifierUse | ||||
Organization.type | required | InterweaveOrganisationType | ||||
Organization.address.use | required | AddressUse |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | 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() | |
dom-4 | error | 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() | |
ele-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period, Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-1 | error | Organization | The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | CareConnect-Organization-1 | A grouping of people or organizations with a common purpose | ||||
id | SΣ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
versionId | SΣ | 0..1 | id | Version specific identifier | ||||
lastUpdated | SΣ | 0..1 | instant | MANDATORY except in Contained Resources. When the resource version last changed. | ||||
profile | SΣ | 0..* | uri | Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile | ||||
security | Σ | 0..* | Coding | DISCOURAGED - 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..* | Coding | Tags 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..1 | Coding | MANDATORY 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The Data Provider Id of the system supplying the data | ||||
display | SΣ | 1..1 | string | Name of the system supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
tag:Provenance | SΣ | 0..1 | Coding | MANDATORY 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..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | The ODS Code of the organisation responsible for the data | ||||
display | SΣ | 1..1 | string | Name of the organisation supplying the data | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
implicitRules | ?!Σ | 0..1 | uri | DISCOURAGED - may not be honoured by Data Consumers | ||||
language | 0..1 | code | English is assumed (not currently a multi-lingual implementation) Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | DISCOURAGED - 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..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
mainLocation | 0..1 | Reference(CareConnect-Location-1) | DISCOURAGED URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-MainLocation-1 | |||||
organization-period | 0..1 | Period | DISCOURAGED URL: http://hl7.org/fhir/StructureDefinition/organization-period | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open At End by value:system | ||||
identifier:odsOrganisationCode | SΣC | 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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/ods-organization-code | ||||
value | SΣ | 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 | ΣC | 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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..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) | ||||
identifier:localIdentifier | ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
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): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Fixed Value: https://fhir.yhcr.nhs.uk/Id/local-organization-identifier | ||||
value | SΣ | 1..1 | string | The Local organization Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456 | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!SΣ | 0..1 | boolean | Whether this organization is still active - must be both populated and understood if 'false' | ||||
type | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: InterweaveOrganisationType (required) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Kind of organization (based on ODS organisation types) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
name | SΣC | 1..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 | C | 0..* | ContactPoint | Contact details of the location. (However contact details of Locations and Practitioners are probably more useful). | ||||
address | SC | 0..1 | Address | An address for the organization | ||||
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 | DISCOURAGED: 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..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal) Example General: both | ||||
text | Σ | 0..1 | string | DISCOURAGED: 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..* | string | Street 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..1 | string | Name of city, town etc. Example General: Erewhon | ||||
district | SΣ | 0..1 | string | District name (aka county) Example General: Madison | ||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
period | Σ | 0..1 | Period | DISCOURAGED: Preferably just relevant current details Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
partOf | Σ | 0..1 | Reference(CareConnect-Organization-1) | DISCOURAGED: Currently require just top-level organisation identifiers - not attempting to build organisation tree | ||||
contact | 0..* | BackboneElement | DISCOURAGED: Not currently needed. Contact details of Locations and Practitioners are probably more useful | |||||
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): The purpose for which you would contact a contact party | |||||
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): The use of a human name | ||||
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 | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Organization.meta.security | extensible | All Security Labels | ||||
Organization.meta.tag | example | Common Tags | ||||
Organization.meta.tag:Source | example | Common Tags | ||||
Organization.meta.tag:Provenance | example | Common Tags | ||||
Organization.language | extensible | Common 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.identifier:localIdentifier.use | required | IdentifierUse | ||||
Organization.identifier:localIdentifier.type | extensible | Identifier Type Codes | ||||
Organization.type | required | InterweaveOrganisationType | ||||
Organization.address.use | required | AddressUse | ||||
Organization.address.type | required | AddressType | ||||
Organization.contact.purpose | extensible | ContactEntityType | ||||
Organization.contact.name.use | required | NameUse |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period, Organization.contact | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | error | Organization.extension:mainLocation, Organization.extension:organization-period | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
org-3 | error | Organization.telecom | The 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:
Other representations of profile: CSV, Excel, Schematron