Skip to content

Organization Profile

Canonical../StructureDefinition/nexus-emr-core-organization
Statusdraft · 1.26.0
BaseOrganization (constraint)
SourceFSH · JSON

Generic Nexus EMR core profile for Organization, based on CA Core+. Designed to support a broad range of integration needs.

FSH

The authored source of truth: resources/StructureDefinition-nexus-emr-core-organization.fsh (edit on GitHub). One FSH file may define several related artifacts.

// NexusEmrCoreOrganization.fsh

Alias: $NexusEmrCoreOrganization = ../StructureDefinition/nexus-emr-core-organization


// Profile Definition
Profile:        NexusEmrCoreOrganization
Parent:         Organization // Using base FHIR as Parent per original
Id:             nexus-emr-core-organization
// Parent:      CACore/organization-ca-core // Alternative if CA Core is Parent
Title:          "Organization Profile"
Description:    "Generic Nexus EMR core profile for Organization, based on CA Core+. Designed to support a broad range of integration needs."
// THE effective date for this profile (see the EffectiveDate / NoEffectiveDate
// RuleSets): one date concept per resource, declared here rather than guessed.
* insert NoEffectiveDate

// SMART on FHIR exposure -- READ-ONLY. An app may read and search this resource but not
// create, update or delete it: this is reference/directory data, maintained by the EMR
// rather than by third-party apps, and a delete here is data loss rather than workflow.
* insert SmartExposedReadOnly(organization)

* ^url = $NexusEmrCoreOrganization // Canonical URL from alias
* ^status = #draft

// --- Element Constraints ---

* . ^short      = "Nexus EMR Organization Core"
* . ^definition = """
  Represents the primary care organization that owns and controls a primary care EMR instance 
  within the Nexus EMR ecosystem. This profile specifically captures primary care entities such as 
  family medicine clinics, primary care networks, or group practices that operate EMR systems. 
  The Organization serves as the administrative entity responsible for the primary care EMR 
  and its data governance.
  """

* meta.source 0..1 MS
* meta.source ^short = "Identifies EMR instance & pipeline version the resource came from"
* meta.source ^definition = "A URI that identifies the EMR pipeline and version from which this resource originated.  This tells you which EMR instance (recommend using the instance identifier), and the version of the pipeline code/transformations."

* text 0..1 MS // Narrative element with human-readable summary
* text ^short = "Narrative"
* text ^definition = "A human-readable narrative summary of the NexusEmrCoreOrganization resource for human interpretation."

// Identifier: optional (0..*), Must Support. A Nexus EMR Org ID is recommended.
* identifier 0..* MS
* identifier.system 1..1
* identifier.value 1..1
* identifier ^short = "Organization identifiers"
* identifier ^definition = """
Unique identifiers for the organization across various systems.

A business identifier is recommended but not required; no specific canonical system is mandated.
"""
* insert SourceIdentifier(identifier)


// Active: Optional, defaults to active when not specified.
* active 0..1 MS
* active ^short = "Whether the organization's record is active"
* active ^definition = "Indicates whether the organization's record is in active use. When absent, the organization is assumed to be active. Set to false only when the organization is no longer operational or has been deactivated."

// Type: Optional classification (e.g., prov, dept).
* type 0..* // Keep optional 0..* from base

// Name: Optional (in rare cases this can be blank), MS.
* name 0..1 MS
* name ^short = "Name used for the organization"
* name ^definition = "The official or common name of the organization. This is typically the name used in formal communications and system displays.  In rare occasions can be blank (Oscar, for example, could have a blank 'organization' filled out)"

// Telecom: Optional, MS per CA-Core on sub-elements.
* telecom 0..* MS // Inherits CA-Core MS on system/value if present
* telecom ^short = "Contact details for the organization"
* telecom ^definition = "Telecommunication details for contacting the organization, including phone, fax, email, and other electronic communication methods."

// Address: Optional, MS per CA-Core on sub-elements.
* address 0..* MS // Inherits CA-Core MS on key components
* address ^short = "Physical location(s) of the organization"
* address ^definition = "Physical addresses where the organization operates or can receive mail. May include multiple locations for organizations with multiple sites."