Polaris FHIR Implementation Guide
1.10.0 - ci-build
Polaris FHIR Implementation Guide - Local Development build (v1.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.apps.health/StructureDefinition/polaris-core-appstate | Version: 1.10.0 | |||
| Active as of 2026-05-26 | Computable Name: PolarisCoreAppState | |||
A profile for representing external application state in Polaris.
The Polaris Core AppState profile represents application state and settings data within the Polaris ecosystem. Based on the FHIR Basic resource and following the SMART App Launch state persistence pattern, this profile enables external applications, integrations, and apps to store and retrieve configuration data, user preferences, and application-specific state information in the FHIR repository.
The AppState profile supports:
AppState follows a structured pattern:
Each application uses its own namespace:
https://fhir.apps.health/CodeSystem/[app-name]-app-stateCurrently supported value extensions:
AppState enables:
Important aspects:
AppState connects to:
Best practices include:
This profile aligns with:
Potential enhancements being evaluated:
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Basic | Polaris App State Core | |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
![]() ![]() |
S | 1..* | Extension | The actual state value(s) - can have an arbitrary number of state values |
![]() ![]() ![]() |
S | 1..1 | uri | Extension type URL |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..1 | Identifier | Business identifier for app state |
![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Type and namespace of application state Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. |
![]() ![]() ![]() |
SΣC | 1..1 | Coding | Coded type of state Constraints: app-state-system-inv |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Application-specific CodeSystem URL |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Specific state type code |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable state type name |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text description of state type |
![]() ![]() |
Σ | 1..1 | Reference(Polaris Patient Core | Polaris PractitionerRole Core | Polaris Organization Core) | Resource this state is associated with |
![]() ![]() ![]() |
SΣC | 0..1 | string | Reference to the associated resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Type of resource referenced Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
SΣ | 0..1 | string | Display name of referenced resource |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Basic.code | example | BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-typeFrom the FHIR Standard | |
| Basic.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| app-state-system-inv | error | Basic.code.coding | AppState coding.system must match Polaris CodeSystem URL rules. : system.matches('https://fhir.apps.health/CodeSystem/[a-zA-Z0-9.-]+-app-state') | |
| dom-2 | error | Basic | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Basic | 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 | Basic | 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 | Basic | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Basic | 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() |
This structure is derived from Basic
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Basic | Polaris App State Core | |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
S | 1..* | Extension | The actual state value(s) - can have an arbitrary number of state values |
![]() ![]() ![]() |
S | 1..1 | uri | Extension type URL |
![]() ![]() |
S | 0..1 | Identifier | Business identifier for app state |
![]() ![]() |
S | 1..1 | CodeableConcept | Type and namespace of application state |
![]() ![]() ![]() |
SC | 1..1 | Coding | Coded type of state Constraints: app-state-system-inv |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Application-specific CodeSystem URL |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Specific state type code |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Human-readable state type name |
![]() ![]() ![]() |
S | 0..1 | string | Plain text description of state type |
![]() ![]() |
1..1 | Reference(Polaris Patient Core | Polaris PractitionerRole Core | Polaris Organization Core) | Resource this state is associated with | |
![]() ![]() ![]() |
S | 0..1 | string | Reference to the associated resource |
![]() ![]() ![]() |
S | 0..1 | uri | Type of resource referenced |
![]() ![]() ![]() |
S | 0..1 | string | Display name of referenced resource |
Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| app-state-system-inv | error | Basic.code.coding | AppState coding.system must match Polaris CodeSystem URL rules. : system.matches('https://fhir.apps.health/CodeSystem/[a-zA-Z0-9.-]+-app-state') |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Basic | Polaris App State Core | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
S | 1..* | Extension | The actual state value(s) - can have an arbitrary number of state values | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 1..1 | uri | Extension type URL | ||||
![]() ![]() ![]() |
0..1 | Value of extension | ||||||
![]() ![]() ![]() ![]() |
base64Binary | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() |
id | |||||||
![]() ![]() ![]() ![]() |
instant | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() |
oid | |||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
unsignedInt | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() |
uuid | |||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() |
ContactPoint | |||||||
![]() ![]() ![]() ![]() |
Count | |||||||
![]() ![]() ![]() ![]() |
Distance | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() |
HumanName | |||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
Signature | |||||||
![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() |
ContactDetail | |||||||
![]() ![]() ![]() ![]() |
Contributor | |||||||
![]() ![]() ![]() ![]() |
DataRequirement | |||||||
![]() ![]() ![]() ![]() |
Expression | |||||||
![]() ![]() ![]() ![]() |
ParameterDefinition | |||||||
![]() ![]() ![]() ![]() |
RelatedArtifact | |||||||
![]() ![]() ![]() ![]() |
TriggerDefinition | |||||||
![]() ![]() ![]() ![]() |
UsageContext | |||||||
![]() ![]() ![]() ![]() |
Dosage | |||||||
![]() ![]() ![]() ![]() |
Meta | |||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | Business identifier for app state | ||||
![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Type and namespace of application state Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | Coding | Coded type of state Constraints: app-state-system-inv | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Application-specific CodeSystem URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Specific state type code | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable state type name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text description of state type | ||||
![]() ![]() |
Σ | 1..1 | Reference(Polaris Patient Core | Polaris PractitionerRole Core | Polaris Organization Core) | Resource this state is associated with | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Reference to the associated resource | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Type of resource referenced Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Display name of referenced resource | ||||
![]() ![]() |
Σ | 0..1 | date | When created | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Who created | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Basic.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Basic.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Basic.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Basic.code | example | BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-typeFrom the FHIR Standard | ||||
| Basic.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| app-state-system-inv | error | Basic.code.coding | AppState coding.system must match Polaris CodeSystem URL rules. : system.matches('https://fhir.apps.health/CodeSystem/[a-zA-Z0-9.-]+-app-state') | |
| dom-2 | error | Basic | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Basic | 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 | Basic | 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 | Basic | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Basic | 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() |
This structure is derived from Basic
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Basic | Polaris App State Core | |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
![]() ![]() |
S | 1..* | Extension | The actual state value(s) - can have an arbitrary number of state values |
![]() ![]() ![]() |
S | 1..1 | uri | Extension type URL |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..1 | Identifier | Business identifier for app state |
![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Type and namespace of application state Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. |
![]() ![]() ![]() |
SΣC | 1..1 | Coding | Coded type of state Constraints: app-state-system-inv |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Application-specific CodeSystem URL |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Specific state type code |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable state type name |
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text description of state type |
![]() ![]() |
Σ | 1..1 | Reference(Polaris Patient Core | Polaris PractitionerRole Core | Polaris Organization Core) | Resource this state is associated with |
![]() ![]() ![]() |
SΣC | 0..1 | string | Reference to the associated resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Type of resource referenced Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
SΣ | 0..1 | string | Display name of referenced resource |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Basic.code | example | BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-typeFrom the FHIR Standard | |
| Basic.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| app-state-system-inv | error | Basic.code.coding | AppState coding.system must match Polaris CodeSystem URL rules. : system.matches('https://fhir.apps.health/CodeSystem/[a-zA-Z0-9.-]+-app-state') | |
| dom-2 | error | Basic | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Basic | 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 | Basic | 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 | Basic | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Basic | 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() |
Differential View
This structure is derived from Basic
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Basic | Polaris App State Core | |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
S | 1..* | Extension | The actual state value(s) - can have an arbitrary number of state values |
![]() ![]() ![]() |
S | 1..1 | uri | Extension type URL |
![]() ![]() |
S | 0..1 | Identifier | Business identifier for app state |
![]() ![]() |
S | 1..1 | CodeableConcept | Type and namespace of application state |
![]() ![]() ![]() |
SC | 1..1 | Coding | Coded type of state Constraints: app-state-system-inv |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Application-specific CodeSystem URL |
![]() ![]() ![]() ![]() |
S | 1..1 | code | Specific state type code |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Human-readable state type name |
![]() ![]() ![]() |
S | 0..1 | string | Plain text description of state type |
![]() ![]() |
1..1 | Reference(Polaris Patient Core | Polaris PractitionerRole Core | Polaris Organization Core) | Resource this state is associated with | |
![]() ![]() ![]() |
S | 0..1 | string | Reference to the associated resource |
![]() ![]() ![]() |
S | 0..1 | uri | Type of resource referenced |
![]() ![]() ![]() |
S | 0..1 | string | Display name of referenced resource |
Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| app-state-system-inv | error | Basic.code.coding | AppState coding.system must match Polaris CodeSystem URL rules. : system.matches('https://fhir.apps.health/CodeSystem/[a-zA-Z0-9.-]+-app-state') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Basic | Polaris App State Core | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
S | 1..* | Extension | The actual state value(s) - can have an arbitrary number of state values | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 1..1 | uri | Extension type URL | ||||
![]() ![]() ![]() |
0..1 | Value of extension | ||||||
![]() ![]() ![]() ![]() |
base64Binary | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() |
id | |||||||
![]() ![]() ![]() ![]() |
instant | |||||||
![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() |
oid | |||||||
![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() |
unsignedInt | |||||||
![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() |
uuid | |||||||
![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() |
ContactPoint | |||||||
![]() ![]() ![]() ![]() |
Count | |||||||
![]() ![]() ![]() ![]() |
Distance | |||||||
![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() |
HumanName | |||||||
![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() |
Signature | |||||||
![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() |
ContactDetail | |||||||
![]() ![]() ![]() ![]() |
Contributor | |||||||
![]() ![]() ![]() ![]() |
DataRequirement | |||||||
![]() ![]() ![]() ![]() |
Expression | |||||||
![]() ![]() ![]() ![]() |
ParameterDefinition | |||||||
![]() ![]() ![]() ![]() |
RelatedArtifact | |||||||
![]() ![]() ![]() ![]() |
TriggerDefinition | |||||||
![]() ![]() ![]() ![]() |
UsageContext | |||||||
![]() ![]() ![]() ![]() |
Dosage | |||||||
![]() ![]() ![]() ![]() |
Meta | |||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..1 | Identifier | Business identifier for app state | ||||
![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Type and namespace of application state Binding: BasicResourceTypes (example): Codes for identifying types of resources not yet defined by FHIR. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | Coding | Coded type of state Constraints: app-state-system-inv | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Application-specific CodeSystem URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Specific state type code | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Human-readable state type name | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Plain text description of state type | ||||
![]() ![]() |
Σ | 1..1 | Reference(Polaris Patient Core | Polaris PractitionerRole Core | Polaris Organization Core) | Resource this state is associated with | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Reference to the associated resource | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Type of resource referenced Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Display name of referenced resource | ||||
![]() ![]() |
Σ | 0..1 | date | When created | ||||
![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | Who created | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Basic.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Basic.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Basic.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Basic.code | example | BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-typeFrom the FHIR Standard | ||||
| Basic.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| app-state-system-inv | error | Basic.code.coding | AppState coding.system must match Polaris CodeSystem URL rules. : system.matches('https://fhir.apps.health/CodeSystem/[a-zA-Z0-9.-]+-app-state') | |
| dom-2 | error | Basic | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Basic | 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 | Basic | 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 | Basic | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Basic | 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() |
This structure is derived from Basic
Other representations of profile: CSV, Excel, Schematron