A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

An Extension

Each slot binds a plan kind (onboarding, default, re-engagement, onboarding-routing) to a versioned PlanDefinition canonical. Set by operators via migration/seeding scripts (setOrganizationPlanSlot). Projo runtime never writes plan-slot — only reads it. Read by the orchestrator's applyTriggeredPlanIfNeeded to select which PlanDefinition to $apply: selectPlanKind picks the lifecycle kind (onboarding for new patients, re-engagement for returning, default otherwise), then resolvePlanCanonicalForKind looks up the slot. For onboarding only, falls back to legacy default-plan (ADR 0003). The onboarding-routing slot is read separately by clinical routing after onboarding completion.

Retired. Set by operators before plan-slot migration. Retained as a read-fallback for onboarding during the plan-slot transition (ADR 0003). Migration script migrate:plan-slots removes in Phase 2.

Set by two writers: (1) the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path (from the reverse CR's inbound-business-phone-id); (2) the sidecar's ensureWhatsAppPhoneNumberId on the first outbound dispatch (queries Meta Graph API GET /{WABA-ID}/phone_numbers, matches by normalized digits, caches back). Read by the sidecar on every outbound dispatch to skip the Graph API lookup. No active refresh — if the cached value becomes stale, WhatsApp sends fail and an operator must clear the extension.

Set by operators for manually-created Organizations, or by the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path. Read by the sidecar to resolve per-WABA credentials from Key Vault (whatsapp-{wabaId}-access-token, whatsapp-{wabaId}-app-secret). No silent fallback — a missing WABA ID causes the sidecar to defer the CR for retry.

Set by operators. Overrides WHATSAPP_INVITATION_TEMPLATE_NAME for this Organization. Read by the sidecar when sending the invitation template.

Set by operators. Overrides WHATSAPP_REMINDER_TEMPLATE_NAME. Read by the sidecar when sending reminder templates.

Set by operators. Overrides WHATSAPP_WEB_INVITATION_TEMPLATE_NAME (ADR 0011). Read by the sidecar when sending web-channel invitation templates.

Set by operators. Overrides WHATSAPP_WEB_REMINDER_TEMPLATE_NAME (ADR 0011). Read by the sidecar when sending web-channel reminder templates.

Set by operators at Organization creation time. Projo never writes this extension — only reads it. Read by buildPatient during identity resolution: getOrganizationPreferredLanguage reads the extension and stamps it onto Patient.communication[0].language.coding[0].code with preferred=true. If absent, the Patient is created without communication preferences and the sidecar's resolvePatientLanguage falls back to 'en'. The patient can later change their language via the dermacare-language-selection Questionnaire, which uses extraction-writeback to update Patient.communication.language.

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

At least one identifier is required. System: https://projo.evoleen.com/fhir/organization. Set by operators at creation time.

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Whether the organization's record is still in active use.

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

At least one phone number is required. This is the WhatsApp Business number patients message. Set by operators at creation time, or by the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path.

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Human contact for the organization.

The WhatsApp Business phone number in E.164 format. Patients send messages to this number. Set by operators or stub-upserted by the orchestrator from the reverse CR's inbound-business-phone extension.

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Human contact for the organization.

Telecommunications form for contact point - what communications system is required to make use of the contact.

Telecommunications form for contact point.

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Need to support legacy numbers that are not in a tightly controlled format.

Identifies the purpose for the contact point.

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Use of contact point.

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

References the root Organization. Set by operators. Customer Organizations are partOf the root; the root Organization has no partOf.

Need to be able to track the hierarchy of organizations within an organization.

Each slot binds a plan kind (onboarding, default, re-engagement, onboarding-routing) to a versioned PlanDefinition canonical. Set by operators via migration/seeding scripts (setOrganizationPlanSlot). Projo runtime never writes plan-slot — only reads it. Read by the orchestrator's applyTriggeredPlanIfNeeded to select which PlanDefinition to $apply: selectPlanKind picks the lifecycle kind (onboarding for new patients, re-engagement for returning, default otherwise), then resolvePlanCanonicalForKind looks up the slot. For onboarding only, falls back to legacy default-plan (ADR 0003). The onboarding-routing slot is read separately by clinical routing after onboarding completion.

Retired. Set by operators before plan-slot migration. Retained as a read-fallback for onboarding during the plan-slot transition (ADR 0003). Migration script migrate:plan-slots removes in Phase 2.

Set by two writers: (1) the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path (from the reverse CR's inbound-business-phone-id); (2) the sidecar's ensureWhatsAppPhoneNumberId on the first outbound dispatch (queries Meta Graph API GET /{WABA-ID}/phone_numbers, matches by normalized digits, caches back). Read by the sidecar on every outbound dispatch to skip the Graph API lookup. No active refresh — if the cached value becomes stale, WhatsApp sends fail and an operator must clear the extension.

Set by operators for manually-created Organizations, or by the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path. Read by the sidecar to resolve per-WABA credentials from Key Vault (whatsapp-{wabaId}-access-token, whatsapp-{wabaId}-app-secret). No silent fallback — a missing WABA ID causes the sidecar to defer the CR for retry.

Set by operators. Overrides WHATSAPP_INVITATION_TEMPLATE_NAME for this Organization. Read by the sidecar when sending the invitation template.

Set by operators. Overrides WHATSAPP_REMINDER_TEMPLATE_NAME. Read by the sidecar when sending reminder templates.

Set by operators. Overrides WHATSAPP_WEB_INVITATION_TEMPLATE_NAME (ADR 0011). Read by the sidecar when sending web-channel invitation templates.

Set by operators. Overrides WHATSAPP_WEB_REMINDER_TEMPLATE_NAME (ADR 0011). Read by the sidecar when sending web-channel reminder templates.

Set by operators at Organization creation time. Projo never writes this extension — only reads it. Read by buildPatient during identity resolution: getOrganizationPreferredLanguage reads the extension and stamps it onto Patient.communication[0].language.coding[0].code with preferred=true. If absent, the Patient is created without communication preferences and the sidecar's resolvePatientLanguage falls back to 'en'. The patient can later change their language via the dermacare-language-selection Questionnaire, which uses extraction-writeback to update Patient.communication.language.

At least one identifier is required. System: https://projo.evoleen.com/fhir/organization. Set by operators at creation time.

At least one phone number is required. This is the WhatsApp Business number patients message. Set by operators at creation time, or by the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path.

The WhatsApp Business phone number in E.164 format. Patients send messages to this number. Set by operators or stub-upserted by the orchestrator from the reverse CR's inbound-business-phone extension.

References the root Organization. Set by operators. Customer Organizations are partOf the root; the root Organization has no partOf.

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

A human language.

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

An Extension

Each slot binds a plan kind (onboarding, default, re-engagement, onboarding-routing) to a versioned PlanDefinition canonical. Set by operators via migration/seeding scripts (setOrganizationPlanSlot). Projo runtime never writes plan-slot — only reads it. Read by the orchestrator's applyTriggeredPlanIfNeeded to select which PlanDefinition to $apply: selectPlanKind picks the lifecycle kind (onboarding for new patients, re-engagement for returning, default otherwise), then resolvePlanCanonicalForKind looks up the slot. For onboarding only, falls back to legacy default-plan (ADR 0003). The onboarding-routing slot is read separately by clinical routing after onboarding completion.

Retired. Set by operators before plan-slot migration. Retained as a read-fallback for onboarding during the plan-slot transition (ADR 0003). Migration script migrate:plan-slots removes in Phase 2.

Set by two writers: (1) the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path (from the reverse CR's inbound-business-phone-id); (2) the sidecar's ensureWhatsAppPhoneNumberId on the first outbound dispatch (queries Meta Graph API GET /{WABA-ID}/phone_numbers, matches by normalized digits, caches back). Read by the sidecar on every outbound dispatch to skip the Graph API lookup. No active refresh — if the cached value becomes stale, WhatsApp sends fail and an operator must clear the extension.

Set by operators for manually-created Organizations, or by the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path. Read by the sidecar to resolve per-WABA credentials from Key Vault (whatsapp-{wabaId}-access-token, whatsapp-{wabaId}-app-secret). No silent fallback — a missing WABA ID causes the sidecar to defer the CR for retry.

Set by operators. Overrides WHATSAPP_INVITATION_TEMPLATE_NAME for this Organization. Read by the sidecar when sending the invitation template.

Set by operators. Overrides WHATSAPP_REMINDER_TEMPLATE_NAME. Read by the sidecar when sending reminder templates.

Set by operators. Overrides WHATSAPP_WEB_INVITATION_TEMPLATE_NAME (ADR 0011). Read by the sidecar when sending web-channel invitation templates.

Set by operators. Overrides WHATSAPP_WEB_REMINDER_TEMPLATE_NAME (ADR 0011). Read by the sidecar when sending web-channel reminder templates.

Set by operators at Organization creation time. Projo never writes this extension — only reads it. Read by buildPatient during identity resolution: getOrganizationPreferredLanguage reads the extension and stamps it onto Patient.communication[0].language.coding[0].code with preferred=true. If absent, the Patient is created without communication preferences and the sidecar's resolvePatientLanguage falls back to 'en'. The patient can later change their language via the dermacare-language-selection Questionnaire, which uses extraction-writeback to update Patient.communication.language.

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

At least one identifier is required. System: https://projo.evoleen.com/fhir/organization. Set by operators at creation time.

Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

Whether the organization's record is still in active use.

This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used.

This element is labeled as a modifier because it may be used to mark that the resource was created in error.

Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

The kind(s) of organization that this is.

Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes

When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center.

We expect that some jurisdictions will profile this optionality to be a single cardinality.

Used to categorize the organization.

Need to be able to track the kind of organization that this is - different organization types have different uses.

A name associated with the organization.

If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Need to use the name as the label of the organization.

A list of alternate names that the organization is known as, or was known as in the past.

There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.

Over time locations and organizations go through many changes and can be known by different names.

For searching knowing previous names that the organization was known by can be very useful.

At least one phone number is required. This is the WhatsApp Business number patients message. Set by operators at creation time, or by the orchestrator's upsertOrganizationFromInboundBusinessPhone on the unresolved-receiver path.

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Human contact for the organization.

The WhatsApp Business phone number in E.164 format. Patients send messages to this number. Set by operators or stub-upserted by the orchestrator from the reverse CR's inbound-business-phone extension.

The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.

Human contact for the organization.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Telecommunications form for contact point - what communications system is required to make use of the contact.

Telecommunications form for contact point.

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Need to support legacy numbers that are not in a tightly controlled format.

Identifies the purpose for the contact point.

Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Use of contact point.

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Time period when the contact point was/is in use.

An address for the organization.

Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

References the root Organization. Set by operators. Customer Organizations are partOf the root; the root Organization has no partOf.

Need to be able to track the hierarchy of organizations within an organization.

Contact for the organization for a certain purpose.

Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.

Need to keep track of assigned contact points within bigger organization.

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Indicates a purpose for which the contact can be reached.

The purpose for which you would contact a contact party.

Need to distinguish between multiple contact persons.

A name associated with the contact.

Need to be able to track the person by name.

A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

People have (primary) ways to contact them in some way such as phone, email.

Visiting or postal addresses for the contact.

May need to keep track of a contact party's address for contacting, billing or reporting requirements.

Technical endpoints providing access to services operated for the organization.

Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.