AU Patient Summary Implementation Guide
0.1.0-cibuild - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/draft-au-patient-summary/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-procedure | Version: 0.1.0-cibuild | |||
Standards status: Informative | Maturity Level: 0 | Computable Name: AUPSProcedure | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile is based on the AU Core profile, with IPS rules added as well (by reference to the IPS profile).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUCoreProcedure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | AUCoreProcedure | This profile also imposes the profile Procedure (IPS) | ||
subject | 1..1 | Reference(AU Patient Summary Patient) | Who the procedure was performed on | |
performer | ||||
actor | 1..1 | Reference(AU Patient Summary Patient | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-relatedperson | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-device-observer | AU Patient Summary Practitioner | AU Patient Summary PractitionerRole | AU Patient Summary Organization) | The reference to the practitioner | |
onBehalfOf | 0..1 | Reference(AU Patient Summary Organization) | Organization the device or practitioner was acting for | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Procedure | 0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also imposes the profile Procedure (IPS) | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
targetBodyStructure | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
status | ?!SOΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): A code specifying the state of the procedure.
| ||||||
code | SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure (extensible)
| ||||||
subject | SOΣ | 1..1 | Reference(AU Patient Summary Patient) | Who the procedure was performed on
| ||||||
encounter | SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of
| ||||||
performed[x] | SOΣ | 0..1 | When the procedure was performed
| |||||||
performedDateTime | dateTime | |||||||||
performedPeriod | Period | |||||||||
performedString | string | |||||||||
performedAge | Age | |||||||||
performedRange | Range | |||||||||
reasonCode | SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||
reasonReference | SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed
| ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Procedure.code | extensible | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | |
Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Procedure | 0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also imposes the profile Procedure (IPS) | |||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
targetBodyStructure | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | Σ | 0..* | Identifier | External Identifiers for this procedure | ||||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||||
partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||||
status | ?!SOΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): A code specifying the state of the procedure.
| ||||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||||
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||||
code | SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure (extensible)
| ||||||
subject | SOΣ | 1..1 | Reference(AU Patient Summary Patient) | Who the procedure was performed on
| ||||||
encounter | SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of
| ||||||
performed[x] | SOΣ | 0..1 | When the procedure was performed
| |||||||
performedDateTime | dateTime | |||||||||
performedPeriod | Period | |||||||||
performedString | string | |||||||||
performedAge | Age | |||||||||
performedRange | Range | |||||||||
recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||||
performer | Σ | 0..* | BackboneElement | The people who performed the procedure | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||||
actor | Σ | 1..1 | Reference(AU Patient Summary Patient | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-relatedperson | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-device-observer | AU Patient Summary Practitioner | AU Patient Summary PractitionerRole | AU Patient Summary Organization) | The reference to the practitioner | ||||||
onBehalfOf | 0..1 | Reference(AU Patient Summary Organization) | Organization the device or practitioner was acting for | |||||||
location | Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||||
reasonCode | SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||
reasonReference | SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed
| ||||||
bodySite | ΣC | 0..* | CodeableConcept | Target body sites Binding: Body Site (extensible) au-core-pro-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||||
report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||||
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||||
complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |||||||
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||||
note | 0..* | Annotation | Additional information about the procedure | |||||||
focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||||
manipulated | 1..1 | Reference(Device) | Device that was changed | |||||||
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||||
usedCode | 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 | URI | |||
Procedure.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reason from the FHIR Standard | ||||
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-category from the FHIR Standard | ||||
Procedure.code | extensible | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Procedure.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcome from the FHIR Standard | ||||
Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followup from the FHIR Standard | ||||
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-action from the FHIR Standard | ||||
Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pro-01 | error | Procedure.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
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() |
This structure is derived from AUCoreProcedure
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUCoreProcedure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | AUCoreProcedure | This profile also imposes the profile Procedure (IPS) | ||
subject | 1..1 | Reference(AU Patient Summary Patient) | Who the procedure was performed on | |
performer | ||||
actor | 1..1 | Reference(AU Patient Summary Patient | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-relatedperson | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-device-observer | AU Patient Summary Practitioner | AU Patient Summary PractitionerRole | AU Patient Summary Organization) | The reference to the practitioner | |
onBehalfOf | 0..1 | Reference(AU Patient Summary Organization) | Organization the device or practitioner was acting for | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Procedure | 0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also imposes the profile Procedure (IPS) | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
Slices for extension | Content/Rules for all slices | |||||||||
targetBodyStructure | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
status | ?!SOΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): A code specifying the state of the procedure.
| ||||||
code | SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure (extensible)
| ||||||
subject | SOΣ | 1..1 | Reference(AU Patient Summary Patient) | Who the procedure was performed on
| ||||||
encounter | SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of
| ||||||
performed[x] | SOΣ | 0..1 | When the procedure was performed
| |||||||
performedDateTime | dateTime | |||||||||
performedPeriod | Period | |||||||||
performedString | string | |||||||||
performedAge | Age | |||||||||
performedRange | Range | |||||||||
reasonCode | SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||
reasonReference | SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed
| ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | |
Procedure.code | extensible | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | |
Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Procedure | 0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also imposes the profile Procedure (IPS) | |||||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||
contained | 0..* | Resource | Contained, inline Resources | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
targetBodyStructure | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | Σ | 0..* | Identifier | External Identifiers for this procedure | ||||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||||
partOf | Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||||
status | ?!SOΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): A code specifying the state of the procedure.
| ||||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||||
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||||
code | SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure (extensible)
| ||||||
subject | SOΣ | 1..1 | Reference(AU Patient Summary Patient) | Who the procedure was performed on
| ||||||
encounter | SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of
| ||||||
performed[x] | SOΣ | 0..1 | When the procedure was performed
| |||||||
performedDateTime | dateTime | |||||||||
performedPeriod | Period | |||||||||
performedString | string | |||||||||
performedAge | Age | |||||||||
performedRange | Range | |||||||||
recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||||
performer | Σ | 0..* | BackboneElement | The people who performed the procedure | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||||
actor | Σ | 1..1 | Reference(AU Patient Summary Patient | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-relatedperson | http://hl7.org.au.draft/fhir/aups/StructureDefinition/au-ps-device-observer | AU Patient Summary Practitioner | AU Patient Summary PractitionerRole | AU Patient Summary Organization) | The reference to the practitioner | ||||||
onBehalfOf | 0..1 | Reference(AU Patient Summary Organization) | Organization the device or practitioner was acting for | |||||||
location | Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||||
reasonCode | SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| ||||||
reasonReference | SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed
| ||||||
bodySite | ΣC | 0..* | CodeableConcept | Target body sites Binding: Body Site (extensible) au-core-pro-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||||
outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||||
report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||||
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||||
complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |||||||
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||||
note | 0..* | Annotation | Additional information about the procedure | |||||||
focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||||
manipulated | 1..1 | Reference(Device) | Device that was changed | |||||||
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||||
usedCode | 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 | URI | |||
Procedure.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Procedure.status | required | EventStatushttp://hl7.org/fhir/ValueSet/event-status|4.0.1 from the FHIR Standard | ||||
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT)http://hl7.org/fhir/ValueSet/procedure-not-performed-reason from the FHIR Standard | ||||
Procedure.category | example | ProcedureCategoryCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-category from the FHIR Standard | ||||
Procedure.code | extensible | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
Procedure.performer.function | example | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-role from the FHIR Standard | ||||
Procedure.reasonCode | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reason from the FHIR Standard | ||||
Procedure.bodySite | extensible | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-outcome from the FHIR Standard | ||||
Procedure.complication | example | Condition/Problem/DiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | ||||
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-followup from the FHIR Standard | ||||
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodeshttp://hl7.org/fhir/ValueSet/device-action from the FHIR Standard | ||||
Procedure.usedCode | example | FHIRDeviceTypeshttp://hl7.org/fhir/ValueSet/device-kind from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
au-core-pro-01 | error | Procedure.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() | |
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() |
This structure is derived from AUCoreProcedure
Summary
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron