Projo FHIR Documentation
0.1.0 - ci-build
Projo FHIR Documentation
0.1.0 - ci-build
Projo FHIR Documentation - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://projo.evoleen.com/fhir/StructureDefinition/projo-organization | Version: 0.1.0 | |||
| Draft as of 2024-01-01 | Computable Name: ProjoOrganization | |||
Copyright/Legal: Copyright (c) Projo. Licensed under CC0-1.0 (public domain dedication). FHIR(R) is the registered trademark of HL7 and is used with permission. This IG references WhatsApp(R), a trademark of Meta Platforms, Inc., for descriptive purposes only. |
||||
Customer/tenant. Each Organization maps to one WhatsApp phone number. Carries the repeating plan-slot extension (ADR 0002) that binds plan kinds to versioned PlanDefinition canonicals, the cached wa-phone-number-id for outbound routing, the WABA account ID for multi-WABA support (issue #238), per-WABA template overrides, and the preferred-language default for onboarded patients. Created by operators (root org) or stub-upserted by the orchestrator on unresolved-receiver identity resolution.
Documentation-only artifact. Projo's runtime extensions, code systems, identifier systems and search parameter are TypeScript constants and bootstrap-time resources, NOT deployed StructureDefinitions. This StructureDefinition exists to document the contract; the source of truth is src/functions/src/lib/fhir/types.ts and docs/FHIR_EXTENSIONS.md.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Organization |
C | 0..* | Organization | Customer/tenant; maps to one WhatsApp phone number Constraints: org-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:planSlot |
0..* | (Complex) | Repeating plan-slot binding (ADR 0002, ADR 0007) URL: https://projo.evoleen.com/fhir/StructureDefinition/plan-slot | |
| extension:defaultPlan |
0..1 | canonical() | Legacy single-plan pointer (retired read-fallback) URL: https://projo.evoleen.com/fhir/StructureDefinition/default-plan | |
| extension:waPhoneNumberId |
0..1 | string | Cached Meta Phone Number ID URL: https://projo.evoleen.com/fhir/StructureDefinition/wa-phone-number-id | |
| extension:wabaAccountId |
0..1 | string | WABA account ID (multi-WABA, issue #238) URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-account-id | |
| extension:wabaTemplateInvitation |
0..1 | string | Per-org invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-invitation | |
| extension:wabaTemplateReminder |
0..1 | string | Per-org reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-reminder | |
| extension:wabaTemplateWebInvitation |
0..1 | string | Per-org web invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-invitation | |
| extension:wabaTemplateWebReminder |
0..1 | string | Per-org web reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-reminder | |
 extension:preferredLanguage |
0..1 | string | ISO 639-1 default language for onboarded patients URL: https://projo.evoleen.com/fhir/StructureDefinition/preferred-language | |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
ΣC | 1..* | Identifier | Operator-chosen tenant identifier |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
 Slices for telecom |
C | 1..* | ContactPoint | E.164 WhatsApp phone numbers Slice: Unordered, Open by value:system Constraints: org-3 |
 telecom:whatsappPhone |
C | 1..1 | ContactPoint | WhatsApp phone number (E.164) Constraints: org-3 |
  system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
| value |
Σ | 1..1 | string | The actual contact point details |
 use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
  partOf |
Σ | 0..1 | Reference(Organization) | Root Organization (multi-tenant hierarchy) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.telecom:whatsappPhone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:whatsappPhone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-3 | error | Organization.telecom, Organization.telecom:whatsappPhone | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | Customer/tenant; maps to one WhatsApp phone number Constraints: org-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:planSlot |
0..* | (Complex) | Repeating plan-slot binding (ADR 0002, ADR 0007) URL: https://projo.evoleen.com/fhir/StructureDefinition/plan-slot | |||||
| extension:defaultPlan |
0..1 | canonical() | Legacy single-plan pointer (retired read-fallback) URL: https://projo.evoleen.com/fhir/StructureDefinition/default-plan | |||||
| extension:waPhoneNumberId |
0..1 | string | Cached Meta Phone Number ID URL: https://projo.evoleen.com/fhir/StructureDefinition/wa-phone-number-id | |||||
| extension:wabaAccountId |
0..1 | string | WABA account ID (multi-WABA, issue #238) URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-account-id | |||||
| extension:wabaTemplateInvitation |
0..1 | string | Per-org invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-invitation | |||||
| extension:wabaTemplateReminder |
0..1 | string | Per-org reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-reminder | |||||
| extension:wabaTemplateWebInvitation |
0..1 | string | Per-org web invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-invitation | |||||
| extension:wabaTemplateWebReminder |
0..1 | string | Per-org web reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-reminder | |||||
| extension:preferredLanguage |
0..1 | string | ISO 639-1 default language for onboarded patients URL: https://projo.evoleen.com/fhir/StructureDefinition/preferred-language | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
ΣC | 1..* | Identifier | Operator-chosen tenant identifier | ||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| type |
Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
| name |
ΣC | 0..1 | string | Name used for the organization | ||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| Slices for telecom |
C | 1..* | ContactPoint | E.164 WhatsApp phone numbers Slice: Unordered, Open by value:system Constraints: org-3 | ||||
| telecom:whatsappPhone |
C | 1..1 | ContactPoint | WhatsApp phone number (E.164) Constraints: org-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
| partOf |
Σ | 0..1 | Reference(Organization) | Root Organization (multi-tenant hierarchy) | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | |||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | example | Organization type | 📍4.0.1 | FHIR Std. |
| Organization.telecom:whatsappPhone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:whatsappPhone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 identifier, 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, Organization.telecom:whatsappPhone | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from Organization
Summary
Mandatory: 5 elements
Fixed: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | Customer/tenant; maps to one WhatsApp phone number Constraints: org-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:planSlot |
0..* | (Complex) | Repeating plan-slot binding (ADR 0002, ADR 0007) URL: https://projo.evoleen.com/fhir/StructureDefinition/plan-slot | |
| extension:defaultPlan |
0..1 | canonical() | Legacy single-plan pointer (retired read-fallback) URL: https://projo.evoleen.com/fhir/StructureDefinition/default-plan | |
| extension:waPhoneNumberId |
0..1 | string | Cached Meta Phone Number ID URL: https://projo.evoleen.com/fhir/StructureDefinition/wa-phone-number-id | |
| extension:wabaAccountId |
0..1 | string | WABA account ID (multi-WABA, issue #238) URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-account-id | |
| extension:wabaTemplateInvitation |
0..1 | string | Per-org invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-invitation | |
| extension:wabaTemplateReminder |
0..1 | string | Per-org reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-reminder | |
| extension:wabaTemplateWebInvitation |
0..1 | string | Per-org web invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-invitation | |
| extension:wabaTemplateWebReminder |
0..1 | string | Per-org web reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-reminder | |
| extension:preferredLanguage |
0..1 | string | ISO 639-1 default language for onboarded patients URL: https://projo.evoleen.com/fhir/StructureDefinition/preferred-language | |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
ΣC | 1..* | Identifier | Operator-chosen tenant identifier |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| Slices for telecom |
C | 1..* | ContactPoint | E.164 WhatsApp phone numbers Slice: Unordered, Open by value:system Constraints: org-3 |
| telecom:whatsappPhone |
C | 1..1 | ContactPoint | WhatsApp phone number (E.164) Constraints: org-3 |
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone |
| value |
Σ | 1..1 | string | The actual contact point details |
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| partOf |
Σ | 0..1 | Reference(Organization) | Root Organization (multi-tenant hierarchy) |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.telecom:whatsappPhone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:whatsappPhone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 identifier, and possibly more than one |
(identifier.count() + name.count()) > 0
|
| org-3 | error | Organization.telecom, Organization.telecom:whatsappPhone | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
Differential View
This structure is derived from Organization
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | Customer/tenant; maps to one WhatsApp phone number Constraints: org-1 | ||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:planSlot |
0..* | (Complex) | Repeating plan-slot binding (ADR 0002, ADR 0007) URL: https://projo.evoleen.com/fhir/StructureDefinition/plan-slot | |||||
| extension:defaultPlan |
0..1 | canonical() | Legacy single-plan pointer (retired read-fallback) URL: https://projo.evoleen.com/fhir/StructureDefinition/default-plan | |||||
| extension:waPhoneNumberId |
0..1 | string | Cached Meta Phone Number ID URL: https://projo.evoleen.com/fhir/StructureDefinition/wa-phone-number-id | |||||
| extension:wabaAccountId |
0..1 | string | WABA account ID (multi-WABA, issue #238) URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-account-id | |||||
| extension:wabaTemplateInvitation |
0..1 | string | Per-org invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-invitation | |||||
| extension:wabaTemplateReminder |
0..1 | string | Per-org reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-reminder | |||||
| extension:wabaTemplateWebInvitation |
0..1 | string | Per-org web invitation template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-invitation | |||||
| extension:wabaTemplateWebReminder |
0..1 | string | Per-org web reminder template override URL: https://projo.evoleen.com/fhir/StructureDefinition/waba-template-web-reminder | |||||
| extension:preferredLanguage |
0..1 | string | ISO 639-1 default language for onboarded patients URL: https://projo.evoleen.com/fhir/StructureDefinition/preferred-language | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
ΣC | 1..* | Identifier | Operator-chosen tenant identifier | ||||
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| type |
Σ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
| name |
ΣC | 0..1 | string | Name used for the organization | ||||
| alias |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| Slices for telecom |
C | 1..* | ContactPoint | E.164 WhatsApp phone numbers Slice: Unordered, Open by value:system Constraints: org-3 | ||||
| telecom:whatsappPhone |
C | 1..1 | ContactPoint | WhatsApp phone number (E.164) Constraints: org-3 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
ΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone | ||||
| value |
Σ | 1..1 | string | The actual contact point details | ||||
| use |
?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank |
Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period |
Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
| partOf |
Σ | 0..1 | Reference(Organization) | Root Organization (multi-tenant hierarchy) | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | |||||
| telecom |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
| address |
0..1 | Address | Visiting or postal addresses for the contact | |||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | example | Organization type | 📍4.0.1 | FHIR Std. |
| Organization.telecom:whatsappPhone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| Organization.telecom:whatsappPhone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
|
| dom-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Organization | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | 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 identifier, 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, Organization.telecom:whatsappPhone | The telecom of an organization can never be of use 'home' |
where(use = 'home').empty()
|
This structure is derived from Organization
Summary
Mandatory: 5 elements
Fixed: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
