Standard Health Record FHIR Implementation Guide

SHR ProcedureNotPerformed Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-ProcedureNotPerformed

This profile builds on US Core Procedure Profile.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Summary

Fixed Value: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.procedure.ProcedureNotPerformed maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure:
  RelatedEncounter maps to context
  Type maps to code
  Subject maps to subject
  Category maps to category
  NotPerformedContext.Reason maps to notDoneReason
  BodySite maps to bodySite
  PartOf maps to partOf
  Annotation maps to note
  constrain performed[x] to 0..0
  constrain performer to 0..0
  fix status to http://hl7.org/fhir/event-status#suspended 
  NotPerformedContext.RelatedRequest maps to basedOn
  NotPerformedContext.RelatedPlan maps to definition
  constrain outcome to 0..0
  constrain location to 0..0

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure SHR ProcedureNotPerformed Profile
... partOf 0..1Reference(SHR ProcedurePerformed Profile)
... status Fixed Value: suspended
... subject Reference(SHR Patient Profile)
... context Reference(SHR EncounterPerformed Profile)
... performed[x] 0..0
... performer 0..0
... location 0..0
... bodySite Binding: SHR BodySiteVS ValueSet (required)
... outcome 0..0
... note SHR Annotation Profile
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure I0..*SHR ProcedureNotPerformed Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... definition Σ0..*Reference(PlanDefinition), Reference(ActivityDefinition), Reference(HealthcareService)Instantiates protocol or definition
... basedOn Σ0..*Reference(CarePlan), Reference(ProcedureRequest), Reference(ReferralRequest)A request for this procedure
... partOf Σ0..1Reference(SHR ProcedurePerformed Profile)Part of referenced event
... status ?!SΣ1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Binding: EventStatus (required)
Fixed Value: suspended
... notDone ?!Σ0..1booleanTrue if procedure was not performed as scheduled
... notDoneReason ΣI0..1CodeableConceptReason procedure was not performed
Binding: Procedure Not Performed Reason (SNOMED-CT) (example)
... category Σ0..1CodeableConceptClassification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code SΣ1..1CodeableConceptSNOMED-CT | ICD-10 | CPT-4
Binding: US Core Procedure Codes (extensible)
... subject SΣ1..1Reference(SHR Patient Profile)Who the procedure was performed on
... context Σ0..1Reference(SHR EncounterPerformed Profile)Encounter or episode associated with the procedure
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Condition that is the reason the procedure performed
... bodySite Σ0..*CodeableConceptTarget body sites
Binding: SHR BodySiteVS ValueSet (required)
... report 0..*Reference(DiagnosticReport)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/Diagnosis Codes (example)
... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: Procedure Follow up Codes (SNOMED CT) (example)
... note 0..*SHR Annotation ProfileAdditional information about the procedure
... focalDevice I0..*BackboneElementDevice changed in procedure
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... action 0..1CodeableConceptKind of change to device
Binding: Procedure Device Action Codes (preferred)
.... manipulated 1..1Reference(Device)Device that was changed
... usedReference 0..*Reference(Device), Reference(Medication), Reference(Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIR Device Types (example)

doco Documentation for this format

Summary

Fixed Value: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.procedure.ProcedureNotPerformed maps to http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure:
  RelatedEncounter maps to context
  Type maps to code
  Subject maps to subject
  Category maps to category
  NotPerformedContext.Reason maps to notDoneReason
  BodySite maps to bodySite
  PartOf maps to partOf
  Annotation maps to note
  constrain performed[x] to 0..0
  constrain performer to 0..0
  fix status to http://hl7.org/fhir/event-status#suspended 
  NotPerformedContext.RelatedRequest maps to basedOn
  NotPerformedContext.RelatedPlan maps to definition
  constrain outcome to 0..0
  constrain location to 0..0

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure SHR ProcedureNotPerformed Profile
... partOf 0..1Reference(SHR ProcedurePerformed Profile)
... status Fixed Value: suspended
... subject Reference(SHR Patient Profile)
... context Reference(SHR EncounterPerformed Profile)
... performed[x] 0..0
... performer 0..0
... location 0..0
... bodySite Binding: SHR BodySiteVS ValueSet (required)
... outcome 0..0
... note SHR Annotation Profile
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Procedure I0..*SHR ProcedureNotPerformed Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-procedure-AssociatedStudy-extension 0..1Reference(SHR Study Profile)SHR AssociatedStudy Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-procedure-AssociatedStudy-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierExternal Identifiers for this procedure
... definition Σ0..*Reference(PlanDefinition), Reference(ActivityDefinition), Reference(HealthcareService)Instantiates protocol or definition
... basedOn Σ0..*Reference(CarePlan), Reference(ProcedureRequest), Reference(ReferralRequest)A request for this procedure
... partOf Σ0..1Reference(SHR ProcedurePerformed Profile)Part of referenced event
... status ?!SΣ1..1codepreparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Binding: EventStatus (required)
Fixed Value: suspended
... notDone ?!Σ0..1booleanTrue if procedure was not performed as scheduled
... notDoneReason ΣI0..1CodeableConceptReason procedure was not performed
Binding: Procedure Not Performed Reason (SNOMED-CT) (example)
... category Σ0..1CodeableConceptClassification of the procedure
Binding: Procedure Category Codes (SNOMED CT) (example)
... code SΣ1..1CodeableConceptSNOMED-CT | ICD-10 | CPT-4
Binding: US Core Procedure Codes (extensible)
... subject SΣ1..1Reference(SHR Patient Profile)Who the procedure was performed on
... context Σ0..1Reference(SHR EncounterPerformed Profile)Encounter or episode associated with the procedure
... reasonCode Σ0..*CodeableConceptCoded reason procedure performed
Binding: Procedure Reason Codes (example)
... reasonReference Σ0..*Reference(Condition), Reference(Observation)Condition that is the reason the procedure performed
... bodySite Σ0..*CodeableConceptTarget body sites
Binding: SHR BodySiteVS ValueSet (required)
... report 0..*Reference(DiagnosticReport)Any report resulting from the procedure
... complication 0..*CodeableConceptComplication following the procedure
Binding: Condition/Problem/Diagnosis Codes (example)
... complicationDetail 0..*Reference(Condition)A condition that is a result of the procedure
... followUp 0..*CodeableConceptInstructions for follow up
Binding: Procedure Follow up Codes (SNOMED CT) (example)
... note 0..*SHR Annotation ProfileAdditional information about the procedure
... focalDevice I0..*BackboneElementDevice changed in procedure
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... action 0..1CodeableConceptKind of change to device
Binding: Procedure Device Action Codes (preferred)
.... manipulated 1..1Reference(Device)Device that was changed
... usedReference 0..*Reference(Device), Reference(Medication), Reference(Substance)Items used during procedure
... usedCode 0..*CodeableConceptCoded items used during the procedure
Binding: FHIR Device Types (example)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Procedure.languageCommon LanguagesextensibleCommon Languages
Procedure.statusEventStatusrequiredEventStatus
Procedure.notDoneReasonProcedure Not Performed Reason (SNOMED-CT)exampleProcedure Not Performed Reason (SNOMED-CT)
Procedure.categoryProcedure Category Codes (SNOMED CT)exampleProcedure Category Codes (SNOMED CT)
Procedure.codeUS Core Procedure CodesextensibleUS Core Procedure Codes
Procedure.performer.roleProcedure Performer Role CodesexampleProcedure Performer Role Codes
Procedure.reasonCodeProcedure Reason CodesexampleProcedure Reason Codes
Procedure.bodySiteSHR BodySiteVS ValueSetrequiredSHR BodySiteVS ValueSet
Procedure.complicationCondition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes
Procedure.followUpProcedure Follow up Codes (SNOMED CT)exampleProcedure Follow up Codes (SNOMED CT)
Procedure.focalDevice.actionProcedure Device Action CodespreferredProcedure Device Action Codes
Procedure.usedCodeFHIR Device TypesexampleFHIR Device Types

 

Constraints

IdPathDetailsRequirements
dom-2ProcedureIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ProcedureIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ProcedureIf 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-3ProcedureIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
pro-1ProcedureReason not done is only permitted if notDone indicator is true
: notDoneReason.empty() or notDone = true
ele-1Procedure.focalDeviceAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())