2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile Health Services Platform Consortium (HSPC) Procedure Profile - Definitions

Todo

Definitions for the hspc-procedure-hspc-procedure Profile.

Procedure(hspc-procedure)
Definition

An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy.

Control1..1
Requirements
Comments
Procedure.id
Definition

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

Control0..1
Typeid
Requirements
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Procedure.meta
Definition

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

Control0..1
TypeMeta
Requirements
Comments
Procedure.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Requirements
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Procedure.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Requirements
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource

Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Procedure.text
Definition

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

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Requirements
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Procedure.contained
Definition

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

Control0..*
TypeResource
Requirements
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Procedure.extension
Definition

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

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • open
  • discriminators: url
Procedure.extension (http://hl7.org/fhir/ExtensionDefinition/procedure-method)
Definition

Method used to perform this procedure.

Control0..1
TypeCodeableConcept
Requirements
Comments

Improve definition. Add mappings.

Procedure.modifierExtension
Definition

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

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

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

Procedure.identifier
Definition

This records identifiers associated with this procedure that are defined by business processed and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Control0..*
TypeIdentifier
Requirements

Need to allow connection to a wider workflow.

Comments
Procedure.patient
Definition

The person on whom the procedure was performed.

Control1..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Patient))
Requirements
Comments
Procedure.type
Definition

The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded.

Control1..1
TypeCodeableConcept
Requirements
Comments
Procedure.bodySite
Definition

Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.

Control0..*
TypeCodeableConcept
Requirements
Comments
Procedure.indication
Definition

The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text.

Control0..*
TypeCodeableConcept
Requirements
Comments

e.g. endoscopy for dilatation and biopsy, combination diagnosis and therapuetic.

Procedure.performer
Definition

Limited to 'real' people rather than equipment.

Control0..*
Requirements
Comments
Procedure.performer.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Procedure.performer.extension
Definition

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

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

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

Procedure.performer.modifierExtension
Definition

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

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

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

Procedure.performer.person
Definition

The practitioner who was involved in the procedure.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner))
Requirements
Comments
Procedure.performer.role
Definition

E.g. surgeon, anaethetist, endoscopist.

Control0..1
TypeCodeableConcept
Requirements
Comments
Procedure.date
Definition

The dates over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

Control0..1
TypePeriod
Requirements
Comments
Procedure.encounter
Definition

The encounter during which the procedure was performed.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/Encounter))
Requirements
Comments
Procedure.outcome
Definition

What was the outcome of the procedure - did it resolve reasons why the procedure was performed?.

Control0..1
Typestring
Requirements
Comments
Procedure.report
Definition

This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies.

Control0..*
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/DiagnosticReport))
Requirements
Comments
Procedure.complication
Definition

Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues.

Control0..*
TypeCodeableConcept
Requirements
Comments
Procedure.followUp
Definition

If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used.

Control0..1
Typestring
Requirements
Comments
Procedure.relatedItem
Definition

Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure.

Control0..*
Requirements
Comments
Procedure.relatedItem.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Requirements
Comments
Procedure.relatedItem.extension
Definition

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

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content
Comments

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

Procedure.relatedItem.modifierExtension
Definition

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

Control0..*
TypeExtension
Requirements
Alternate Namesextensions, user content, modifiers
Comments

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

Procedure.relatedItem.type
Definition

The nature of the relationship.

Control0..1
BindingThe nature of the relationship with this procedure
The codes SHALL be taken from ProcedureRelationshipType
Typecode
Requirements
Comments
Procedure.relatedItem.target
Definition

The related item - e.g. a procedure.

Control0..1
TypeChoice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/AllergyIntolerance)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/CarePlan)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Condition)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/DiagnosticReport)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/FamilyHistory)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ImagingStudy)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Immunization)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ImmunizationRecommendation)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/MedicationAdministration)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/MedicationDispense)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/MedicationPrescription)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/MedicationStatement)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Observation)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Procedure))
Requirements
Comments
Procedure.notes
Definition

Any other notes about the procedure - e.g. the operative notes.

Control0..1
Typestring
Requirements
Comments