Procedure constructor
- @Default(R5ResourceType.Procedure) @JsonKey(unknownEnumValue: R5ResourceType.Procedure) R5ResourceType resourceType,
- @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
- @JsonKey(name: 'id') FhirId? fhirId,
- FhirMeta? meta,
- FhirUri? implicitRules,
- @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
- FhirCode? language,
- @JsonKey(name: '_language') Element? languageElement,
- Narrative? text,
- List<
Resource> ? contained, - @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - List<
FhirExtension> ? modifierExtension, - List<
Identifier> ? identifier, - List<
FhirCanonical> ? instantiatesCanonical, - List<
FhirUri> ? instantiatesUri, - @JsonKey(name: '_instantiatesUri') List<
Element> ? instantiatesUriElement, - List<
Reference> ? basedOn, - List<
Reference> ? partOf, - FhirCode? status,
- @JsonKey(name: '_status') Element? statusElement,
- CodeableConcept? statusReason,
- List<
CodeableConcept> ? category, - CodeableConcept? code,
- required Reference subject,
- Reference? focus,
- Reference? encounter,
- FhirDateTime? occurrenceDateTime,
- @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement,
- Period? occurrencePeriod,
- String? occurrenceString,
- @JsonKey(name: '_occurrenceString') Element? occurrenceStringElement,
- Age? occurrenceAge,
- Range? occurrenceRange,
- Timing? occurrenceTiming,
- FhirDateTime? recorded,
- @JsonKey(name: '_recorded') Element? recordedElement,
- Reference? recorder,
- FhirBoolean? reportedBoolean,
- @JsonKey(name: '_reportedBoolean') Element? reportedBooleanElement,
- Reference? reportedReference,
- List<
ProcedurePerformer> ? performer, - Reference? location,
- List<
CodeableReference> ? reason, - List<
CodeableConcept> ? bodySite, - CodeableConcept? outcome,
- List<
Reference> ? report, - List<
CodeableReference> ? complication, - List<
CodeableConcept> ? followUp, - List<
Annotation> ? note, - List<
ProcedureFocalDevice> ? focalDevice, - List<
CodeableReference> ? used, - List<
Reference> ? supportingInfo,
Procedure An action that is or was performed on or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.
resourceType
This is a Procedure resource
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta
The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
implicitRules
A reference to a set of rules that were followed when the
resource was constructed, and which must be understood when processing
the content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
implicitRulesElement
("_implicitRules") Extensions for implicitRules
language
The base language in which the resource is written.
languageElement
("_language") Extensions for language
text
A human-readable narrative that contains a summary of the resource
and can 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.
contained
These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it is
referenced by a resource that provides context/meaning.
extension_
("extension") May be used to represent additional
information that is not part of the basic definition of the resource. To
make the use of extensions safe and managable, there is a strict set of
governance applied to the definition and use of extensions. Though any
implementer can define an extension, there is a set of requirements that
SHALL be met as part of the definition of the extension.
modifierExtension
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 and/or the
understanding of the containing element's descendants. Usually modifier
elements provide negation or qualification. To make the use of
extensions safe and managable, 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.Modifier extensions SHALL NOT change the meaning of any
elements on Resource or DomainResource (including cannot change the
meaning of modifierExtension itself).
identifier
Business identifiers assigned to this procedure by the
performer or other systems which remain constant as the resource is
updated and is propagated from server to server.
instantiatesCanonical
The URL pointing to a FHIR-defined protocol,
guideline, order set or other definition that is adhered to in whole or
in part by this Procedure.
instantiatesUri
The URL pointing to an externally maintained protocol,
guideline, order set or other definition that is adhered to in whole or
in part by this Procedure.
instantiatesUriElement
("_instantiatesUri") Extensions for
instantiatesUri
basedOn
A reference to a resource that contains details of the request
for this procedure.
partOf
A larger event of which this particular procedure is a component
or step.
status
A code specifying the state of the procedure. Generally, this
will be the in-progress or completed state.
statusElement
("_status") Extensions for status
statusReason
Captures the reason for the current state of the procedure.
category
A code that classifies the procedure for searching, sorting
and display purposes (e.g. "Surgical Procedure").
code
The specific procedure that is performed. Use text if the exact
nature of the procedure cannot be coded (e.g. "Laparoscopic
Appendectomy").
subject
On whom or on what the procedure was performed. This is usually
an individual human, but can also be performed on animals, groups of
humans or animals, organizations or practitioners (for licensing),
locations or devices (for safety inspections or regulatory
authorizations). If the actual focus of the procedure is different from
the subject, the focus element specifies the actual focus of the
procedure.
focus
Who is the target of the procedure when it is not the subject of
record only. If focus is not present, then subject is the focus. If
focus is present and the subject is one of the targets of the procedure,
include subject as a focus as well. If focus is present and the subject
is not included in focus, it implies that the procedure was only
targeted on the focus. For example, when a caregiver is given education
for a patient, the caregiver would be the focus and the procedure record
is associated with the subject (e.g. patient). For example, use focus
when recording the target of the education, training, or counseling is
the parent or relative of a patient.
encounter
The Encounter during which this Procedure was created or
performed or to which the creation of this record is tightly associated.
occurrenceDateTime
Estimated or actual date, date-time, period, or age
when the procedure did occur or is occurring. 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.
occurrenceDateTimeElement
("_occurrenceDateTime") Extensions for
occurrenceDateTime
occurrencePeriod
Estimated or actual date, date-time, period, or age
when the procedure did occur or is occurring. 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.
occurrenceString
Estimated or actual date, date-time, period, or age
when the procedure did occur or is occurring. 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.
occurrenceStringElement
("_occurrenceString") Extensions for
occurrenceString
occurrenceAge
Estimated or actual date, date-time, period, or age when
the procedure did occur or is occurring. 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.
occurrenceRange
Estimated or actual date, date-time, period, or age
when the procedure did occur or is occurring. 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.
occurrenceTiming
Estimated or actual date, date-time, period, or age
when the procedure did occur or is occurring. 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.
recorded
The date the occurrence of the procedure was first captured in
the record regardless of Procedure.status (potentially after the
occurrence of the event).
recordedElement
("_recorded") Extensions for recorded
recorder
Individual who recorded the record and takes responsibility
for its content.
reportedBoolean
Indicates if this record was captured as a secondary
'reported' record rather than as an original primary source-of-truth
record. It may also indicate the source of the report.
reportedBooleanElement
("_reportedBoolean") Extensions for
reportedBoolean
reportedReference
Indicates if this record was captured as a secondary
'reported' record rather than as an original primary source-of-truth
record. It may also indicate the source of the report.
performer
Indicates who or what performed the procedure and how they
were involved.
location
The location where the procedure actually happened. E.g. a
newborn at home, a tracheostomy at a restaurant.
reason
The coded reason or reference why the procedure was performed.
This may be a coded entity of some type, be present as text, or be a
reference to one of several resources that justify the procedure.
bodySite
Detailed and structured anatomical location information.
Multiple locations are allowed - e.g. multiple punch biopsies of a
lesion.
outcome
The outcome of the procedure - did it resolve the reasons for
the procedure being performed?
report
This could be a histology result, pathology report, surgical
report, etc.
complication
Any complications that occurred during the procedure, or
in the immediate post-performance period. These are generally tracked
separately from the notes, which will typically describe the procedure
itself rather than any 'post procedure' issues.
followUp
If the procedure required specific follow up - e.g. removal of
sutures. The follow up may be represented as a simple note or could
potentially be more complex, in which case the CarePlan resource can be
used.
note
Any other notes and comments about the procedure.
focalDevice
A device that is implanted, removed or otherwise
manipulated (calibration, battery replacement, fitting a prosthesis,
attaching a wound-vac, etc.) as a focal portion of the Procedure.
used
Identifies medications, devices and any other substance used as
part of the procedure.
supportingInfo
Other resources from the patient record that may be
relevant to the procedure. The information from these resources was
either used to create the instance or is provided to help with its
interpretation. This extension should not be used if more specific
inline elements or extensions are available.
Implementation
const factory Procedure({
/// [resourceType] This is a Procedure resource
@Default(R5ResourceType.Procedure)
@JsonKey(unknownEnumValue: R5ResourceType.Procedure)
R5ResourceType resourceType,
@JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
/// [id] The logical id of the resource, as used in the URL for the
/// resource. Once assigned, this value never changes.
@JsonKey(name: 'id') FhirId? fhirId,
/// [meta] The metadata about the resource. This is content that is
/// maintained by the infrastructure. Changes to the content might not
/// always be associated with version changes to the resource.
FhirMeta? meta,
/// [implicitRules] A reference to a set of rules that were followed when
/// the resource was constructed, and which must be understood when
/// processing the content. Often, this is a reference to an
/// implementation guide that defines the special rules along with other
/// profiles etc.
FhirUri? implicitRules,
/// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
@JsonKey(name: '_implicitRules') Element? implicitRulesElement,
/// [language] The base language in which the resource is written.
FhirCode? language,
/// [languageElement] ("_language") Extensions for language
@JsonKey(name: '_language') Element? languageElement,
/// [text] A human-readable narrative that contains a summary of the
/// resource and can 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.
Narrative? text,
/// [contained] These resources do not have an independent existence apart
/// from the resource that contains them - they cannot be identified
/// independently, nor can they have their own independent transaction
/// scope. This is allowed to be a Parameters resource if and only if it
/// is referenced by a resource that provides context/meaning.
List<Resource>? contained,
/// [extension_] ("extension") May be used to represent additional
/// information that is not part of the basic definition of the resource.
/// To make the use of extensions safe and managable, there is a strict
/// set of governance applied to the definition and use of extensions.
/// Though any implementer can define an extension, there is a set of
/// requirements that SHALL be met as part of the definition of the
/// extension.
@JsonKey(name: 'extension') List<FhirExtension>? extension_,
/// [modifierExtension] 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 and/or the
/// understanding of the containing element's descendants. Usually
/// modifier elements provide negation or qualification. To make the use
/// of extensions safe and managable, 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.Modifier extensions SHALL NOT change the
/// meaning of any elements on Resource or DomainResource (including
/// cannot change the meaning of modifierExtension itself).
List<FhirExtension>? modifierExtension,
/// [identifier] Business identifiers assigned to this procedure by the
/// performer or other systems which remain constant as the resource is
/// updated and is propagated from server to server.
List<Identifier>? identifier,
/// [instantiatesCanonical] The URL pointing to a FHIR-defined protocol,
/// guideline, order set or other definition that is adhered to in whole
/// or in part by this Procedure.
List<FhirCanonical>? instantiatesCanonical,
/// [instantiatesUri] The URL pointing to an externally maintained
/// protocol, guideline, order set or other definition that is adhered to
/// in whole or in part by this Procedure.
List<FhirUri>? instantiatesUri,
/// [instantiatesUriElement] ("_instantiatesUri") Extensions for
/// instantiatesUri
@JsonKey(name: '_instantiatesUri') List<Element>? instantiatesUriElement,
/// [basedOn] A reference to a resource that contains details of the
/// request for this procedure.
List<Reference>? basedOn,
/// [partOf] A larger event of which this particular procedure is a
/// component or step.
List<Reference>? partOf,
/// [status] A code specifying the state of the procedure. Generally, this
/// will be the in-progress or completed state.
FhirCode? status,
/// [statusElement] ("_status") Extensions for status
@JsonKey(name: '_status') Element? statusElement,
/// [statusReason] Captures the reason for the current state of the
/// procedure.
CodeableConcept? statusReason,
/// [category] A code that classifies the procedure for searching, sorting
/// and display purposes (e.g. "Surgical Procedure").
List<CodeableConcept>? category,
/// [code] The specific procedure that is performed. Use text if the exact
/// nature of the procedure cannot be coded (e.g. "Laparoscopic
/// Appendectomy").
CodeableConcept? code,
/// [subject] On whom or on what the procedure was performed. This is
/// usually an individual human, but can also be performed on animals,
/// groups of humans or animals, organizations or practitioners (for
/// licensing), locations or devices (for safety inspections or regulatory
/// authorizations). If the actual focus of the procedure is different
/// from the subject, the focus element specifies the actual focus of the
/// procedure.
required Reference subject,
/// [focus] Who is the target of the procedure when it is not the subject
/// of record only. If focus is not present, then subject is the focus.
/// If focus is present and the subject is one of the targets of the
/// procedure, include subject as a focus as well. If focus is present and
/// the subject is not included in focus, it implies that the procedure
/// was only targeted on the focus. For example, when a caregiver is given
/// education for a patient, the caregiver would be the focus and the
/// procedure record is associated with the subject (e.g. patient). For
/// example, use focus when recording the target of the education,
/// training, or counseling is the parent or relative of a patient.
Reference? focus,
/// [encounter] The Encounter during which this Procedure was created or
/// performed or to which the creation of this record is tightly
/// associated.
Reference? encounter,
/// [occurrenceDateTime] Estimated or actual date, date-time, period, or
/// age when the procedure did occur or is occurring. 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.
FhirDateTime? occurrenceDateTime,
/// [occurrenceDateTimeElement] ("_occurrenceDateTime") Extensions for
/// occurrenceDateTime
@JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement,
/// [occurrencePeriod] Estimated or actual date, date-time, period, or age
/// when the procedure did occur or is occurring. 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.
Period? occurrencePeriod,
/// [occurrenceString] Estimated or actual date, date-time, period, or age
/// when the procedure did occur or is occurring. 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.
String? occurrenceString,
/// [occurrenceStringElement] ("_occurrenceString") Extensions for
/// occurrenceString
@JsonKey(name: '_occurrenceString') Element? occurrenceStringElement,
/// [occurrenceAge] Estimated or actual date, date-time, period, or age
/// when the procedure did occur or is occurring. 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.
Age? occurrenceAge,
/// [occurrenceRange] Estimated or actual date, date-time, period, or age
/// when the procedure did occur or is occurring. 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.
Range? occurrenceRange,
/// [occurrenceTiming] Estimated or actual date, date-time, period, or age
/// when the procedure did occur or is occurring. 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.
Timing? occurrenceTiming,
/// [recorded] The date the occurrence of the procedure was first captured
/// in the record regardless of Procedure.status (potentially after the
/// occurrence of the event).
FhirDateTime? recorded,
/// [recordedElement] ("_recorded") Extensions for recorded
@JsonKey(name: '_recorded') Element? recordedElement,
/// [recorder] Individual who recorded the record and takes responsibility
/// for its content.
Reference? recorder,
/// [reportedBoolean] Indicates if this record was captured as a secondary
/// 'reported' record rather than as an original primary source-of-truth
/// record. It may also indicate the source of the report.
FhirBoolean? reportedBoolean,
/// [reportedBooleanElement] ("_reportedBoolean") Extensions for
/// reportedBoolean
@JsonKey(name: '_reportedBoolean') Element? reportedBooleanElement,
/// [reportedReference] Indicates if this record was captured as a
/// secondary 'reported' record rather than as an original primary
/// source-of-truth record. It may also indicate the source of the report.
Reference? reportedReference,
/// [performer] Indicates who or what performed the procedure and how they
/// were involved.
List<ProcedurePerformer>? performer,
/// [location] The location where the procedure actually happened. E.g. a
/// newborn at home, a tracheostomy at a restaurant.
Reference? location,
/// [reason] The coded reason or reference why the procedure was performed.
/// This may be a coded entity of some type, be present as text, or be a
/// reference to one of several resources that justify the procedure.
List<CodeableReference>? reason,
/// [bodySite] Detailed and structured anatomical location information.
/// Multiple locations are allowed - e.g. multiple punch biopsies of a
/// lesion.
List<CodeableConcept>? bodySite,
/// [outcome] The outcome of the procedure - did it resolve the reasons for
/// the procedure being performed?
CodeableConcept? outcome,
/// [report] This could be a histology result, pathology report, surgical
/// report, etc.
List<Reference>? report,
/// [complication] Any complications that occurred during the procedure, or
/// in the immediate post-performance period. These are generally tracked
/// separately from the notes, which will typically describe the procedure
/// itself rather than any 'post procedure' issues.
List<CodeableReference>? complication,
/// [followUp] If the procedure required specific follow up - e.g. removal
/// of sutures. The follow up may be represented as a simple note or could
/// potentially be more complex, in which case the CarePlan resource can
/// be used.
List<CodeableConcept>? followUp,
/// [note] Any other notes and comments about the procedure.
List<Annotation>? note,
/// [focalDevice] A device that is implanted, removed or otherwise
/// manipulated (calibration, battery replacement, fitting a prosthesis,
/// attaching a wound-vac, etc.) as a focal portion of the Procedure.
List<ProcedureFocalDevice>? focalDevice,
/// [used] Identifies medications, devices and any other substance used as
/// part of the procedure.
List<CodeableReference>? used,
/// [supportingInfo] Other resources from the patient record that may be
/// relevant to the procedure. The information from these resources was
/// either used to create the instance or is provided to help with its
/// interpretation. This extension should not be used if more specific
/// inline elements or extensions are available.
List<Reference>? supportingInfo,
}) = _Procedure;