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-procedure | Version: 1.10.0 | |||
| Draft as of 2026-05-26 | Computable Name: PolarisCoreProcedure | |||
Defines the Polaris FHIR profile for Procedure resources, based on CA-Core Procedure constraints, for aggregating data from multiple EMRs.
The Polaris Core Procedure profile represents surgical procedures, diagnostic procedures, and therapeutic interventions performed on patients within primary care EMR systems. This profile captures comprehensive procedure details including codes, timing, performers, body sites, and outcomes across the Polaris ecosystem.
Common procedure categories include:
Essential elements include:
The procedure profile supports:
Procedures often link to:
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Procedure | Polaris Procedure Core Constraints: procedure-has-polaris-id |
![]() ![]() |
Σ | 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 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for procedure Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Procedure ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris procedure identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-procedure-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris procedure ID value: unique in source system Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR procedure identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-raw-code Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | completed | entered-in-error Binding: EventStatus (required) |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Procedure performed with raw code support Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . |
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Standard procedure code (CPT, SNOMED, LOINC) if available |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR procedure code |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-code-raw-code |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | EMR-specific procedure code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this procedure |
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-readable procedure description (required) |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | Who the procedure was performed on |
![]() ![]() |
Σ | 0..1 | Reference(Polaris Encounter Profile Core) | Encounter when procedure was performed |
![]() ![]() |
SΣ | 0..1 | When the procedure was performed | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept |
![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. |
![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |
![]() ![]() |
S | 0..* | Annotation | Additional information about the procedure |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Procedure.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Procedure.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-statusFrom the FHIR Standard | |
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryFrom the FHIR Standard | |
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | |
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcomeFrom the FHIR Standard | |
| Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | 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 | Procedure | 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 | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | 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() | |
| procedure-has-polaris-id | error | Procedure | Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-procedure-identifier$')) |
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Procedure | Polaris Procedure Core Constraints: procedure-has-polaris-id |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
S | 1..* | Identifier | Business identifier(s) for procedure Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris Procedure ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris procedure identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-procedure-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual Polaris procedure ID value: unique in source system | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR procedure identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-raw-code | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | completed | entered-in-error Binding: EventStatus (required) |
![]() ![]() |
S | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) |
![]() ![]() |
S | 1..1 | CodeableConcept | Procedure performed with raw code support |
![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
0..* | Coding | Standard procedure code (CPT, SNOMED, LOINC) if available | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR procedure code |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-code-raw-code |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | EMR-specific procedure code |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this procedure | |
![]() ![]() ![]() |
S | 1..1 | string | Human-readable procedure description (required) |
![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Who the procedure was performed on |
![]() ![]() |
0..1 | Reference(Polaris Encounter Profile Core) | Encounter when procedure was performed | |
![]() ![]() |
S | 0..1 | dateTime, Period, string, Age, Range | When the procedure was performed |
![]() ![]() |
S | 0..* | CodeableConcept | Target body sites |
![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept |
![]() ![]() |
0..1 | CodeableConcept | The result of procedure | |
![]() ![]() |
0..* | CodeableConcept | Complication following the procedure | |
![]() ![]() |
S | 0..* | Annotation | Additional information about the procedure |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-statusFrom the FHIR Standard | |
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| procedure-has-polaris-id | error | Procedure | Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-procedure-identifier$')) |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Procedure | Polaris Procedure Core Constraints: procedure-has-polaris-id | ||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for procedure Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Procedure ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris procedure identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-procedure-identifier Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris procedure ID value: unique in source system Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR procedure identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-raw-code Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||
![]() ![]() |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | completed | entered-in-error Binding: EventStatus (required) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Procedure performed with raw code support Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Standard procedure code (CPT, SNOMED, LOINC) if available | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR procedure code | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-code-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | EMR-specific procedure code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this procedure | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-readable procedure description (required) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | Who the procedure was performed on | ||||
![]() ![]() |
Σ | 0..1 | Reference(Polaris Encounter Profile Core) | Encounter when procedure was performed | ||||
![]() ![]() |
SΣ | 0..1 | When the procedure was performed | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | ||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
![]() ![]() |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
![]() ![]() |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
![]() ![]() |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
![]() ![]() |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
![]() ![]() |
S | 0..* | Annotation | Additional information about the procedure | ||||
![]() ![]() |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
![]() ![]() ![]() |
1..1 | Reference(Device) | Device that was changed | |||||
![]() ![]() |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
![]() ![]() |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Procedure.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Procedure.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Procedure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Procedure.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Procedure.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Procedure.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Procedure.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-statusFrom the FHIR Standard | ||||
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonFrom the FHIR Standard | ||||
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryFrom the FHIR Standard | ||||
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-roleFrom the FHIR Standard | ||||
| Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonFrom the FHIR Standard | ||||
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcomeFrom the FHIR Standard | ||||
| Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codeFrom the FHIR Standard | ||||
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followupFrom the FHIR Standard | ||||
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-actionFrom the FHIR Standard | ||||
| Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | 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 | Procedure | 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 | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | 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() | |
| procedure-has-polaris-id | error | Procedure | Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-procedure-identifier$')) |
This structure is derived from Procedure
Summary
Mandatory: 6 elements(8 nested mandatory elements)
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Procedure | Polaris Procedure Core Constraints: procedure-has-polaris-id |
![]() ![]() |
Σ | 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 |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for procedure Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Procedure ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris procedure identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-procedure-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris procedure ID value: unique in source system Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR procedure identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-raw-code Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | completed | entered-in-error Binding: EventStatus (required) |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) |
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Procedure performed with raw code support Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . |
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Standard procedure code (CPT, SNOMED, LOINC) if available |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR procedure code |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-code-raw-code |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | EMR-specific procedure code |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this procedure |
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-readable procedure description (required) |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | Who the procedure was performed on |
![]() ![]() |
Σ | 0..1 | Reference(Polaris Encounter Profile Core) | Encounter when procedure was performed |
![]() ![]() |
SΣ | 0..1 | When the procedure was performed | |
![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
string | |||
![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() |
Range | |||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept |
![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. |
![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |
![]() ![]() |
S | 0..* | Annotation | Additional information about the procedure |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Procedure.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Procedure.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-statusFrom the FHIR Standard | |
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryFrom the FHIR Standard | |
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | |
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcomeFrom the FHIR Standard | |
| Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | 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 | Procedure | 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 | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | 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() | |
| procedure-has-polaris-id | error | Procedure | Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-procedure-identifier$')) |
Differential View
This structure is derived from Procedure
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Procedure | Polaris Procedure Core Constraints: procedure-has-polaris-id |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
S | 1..* | Identifier | Business identifier(s) for procedure Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris Procedure ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris procedure identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-procedure-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual Polaris procedure ID value: unique in source system | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR procedure identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-raw-code | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | preparation | in-progress | completed | entered-in-error Binding: EventStatus (required) |
![]() ![]() |
S | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) |
![]() ![]() |
S | 1..1 | CodeableConcept | Procedure performed with raw code support |
![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() ![]() |
0..* | Coding | Standard procedure code (CPT, SNOMED, LOINC) if available | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Standard terminology system URI |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Source EMR procedure code |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-code-raw-code |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | EMR-specific procedure code |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | EMR's display text for this procedure | |
![]() ![]() ![]() |
S | 1..1 | string | Human-readable procedure description (required) |
![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Who the procedure was performed on |
![]() ![]() |
0..1 | Reference(Polaris Encounter Profile Core) | Encounter when procedure was performed | |
![]() ![]() |
S | 0..1 | dateTime, Period, string, Age, Range | When the procedure was performed |
![]() ![]() |
S | 0..* | CodeableConcept | Target body sites |
![]() ![]() ![]() |
S | 1..1 | string | Plain text representation of the concept |
![]() ![]() |
0..1 | CodeableConcept | The result of procedure | |
![]() ![]() |
0..* | CodeableConcept | Complication following the procedure | |
![]() ![]() |
S | 0..* | Annotation | Additional information about the procedure |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-statusFrom the FHIR Standard | |
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| procedure-has-polaris-id | error | Procedure | Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-procedure-identifier$')) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Procedure | Polaris Procedure Core Constraints: procedure-has-polaris-id | ||||
![]() ![]() |
Σ | 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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for procedure Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Procedure ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris procedure identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-procedure-identifier Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris procedure ID value: unique in source system Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR procedure identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-raw-code Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||
![]() ![]() |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
![]() ![]() |
?!SΣ | 1..1 | code | preparation | in-progress | completed | entered-in-error Binding: EventStatus (required) | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) | ||||
![]() ![]() |
SΣ | 1..1 | CodeableConcept | Procedure performed with raw code support Binding: ProcedureCodes(SNOMEDCT) (example): A code to identify a specific procedure . | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Standard procedure code (CPT, SNOMED, LOINC) if available | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Standard terminology system URI | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Source EMR procedure code | ||||
![]() ![]() ![]() ![]() ![]() |
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 | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-procedure-code-raw-code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | EMR-specific procedure code | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | EMR's display text for this procedure | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Human-readable procedure description (required) | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | Who the procedure was performed on | ||||
![]() ![]() |
Σ | 0..1 | Reference(Polaris Encounter Profile Core) | Encounter when procedure was performed | ||||
![]() ![]() |
SΣ | 0..1 | When the procedure was performed | |||||
![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() |
Range | |||||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | ||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
![]() ![]() |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | Target body sites Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
![]() ![]() |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
![]() ![]() |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
![]() ![]() |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
![]() ![]() |
S | 0..* | Annotation | Additional information about the procedure | ||||
![]() ![]() |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
![]() ![]() ![]() |
1..1 | Reference(Device) | Device that was changed | |||||
![]() ![]() |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
![]() ![]() |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Procedure.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Procedure.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Procedure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Procedure.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Procedure.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Procedure.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Procedure.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-statusFrom the FHIR Standard | ||||
| Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reasonFrom the FHIR Standard | ||||
| Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-categoryFrom the FHIR Standard | ||||
| Procedure.code | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-codeFrom the FHIR Standard | ||||
| Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-roleFrom the FHIR Standard | ||||
| Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonFrom the FHIR Standard | ||||
| Procedure.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | ||||
| Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcomeFrom the FHIR Standard | ||||
| Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-codeFrom the FHIR Standard | ||||
| Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followupFrom the FHIR Standard | ||||
| Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-actionFrom the FHIR Standard | ||||
| Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kindFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Procedure | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Procedure | 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 | Procedure | 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 | Procedure | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Procedure | 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() | |
| procedure-has-polaris-id | error | Procedure | Must have at least one identifier with a canonical Polaris system URI : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-procedure-identifier$')) |
This structure is derived from Procedure
Summary
Mandatory: 6 elements(8 nested mandatory elements)
Must-Support: 20 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron