AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide
1.0.1-ci-build - 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 1.0.1-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-ps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-procedure | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUPSProcedure | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Procedure resource in the context of a patient summary in an Australian context. It is based on the AU Core Procedure profile, and applies the additional requirements from Procedure (IPS).
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
Procedure.reasonCode, or a reference with Procedure.reasonReference to a Condition or other resource.
The additional obligation on Procedure.performedDateTime for AU PS Producer is SHOULD:able-to-populate. This obligation is in addition to the obligation of SHALL:populate-if-known. There is no additional obligation for AU PS Consumer, the obligations of SHALL:handle and SHOULD:display apply.
This additional obligation is present in the underlying structure but due to a tooling limitation is not currently rendered in the Formal Views of Profile Content. See Zulip discussion for more information.
Examples for this Profile: Bundle/aups-gpvisit-retrieval
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:  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Procedure |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with 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 | |||||||||||
   extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||
 extension: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 |
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 |
1..1 | CodeableConceptIPS | Identification of the procedure Binding: Procedure  (extensible)
| |||||||||
 subject |
1..1 | Reference(AU PS Patient) | Who the procedure was performed on
| |||||||||
 reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of
| |||||||||
 performed[x] |
1..1 | When the procedure was performed
| ||||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| reasonCode |
0..* | CodeableConceptIPS | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation | AU PS Procedure | DocumentReference) | The justification that the procedure was performed
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | extensible |
Procedure
|
⏿1.0.2 | tx.hl7.org.au |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with the profile Procedure (IPS) | |||||||||
 status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
| |||||||||
| code |
1..1 | CodeableConceptIPS | Identification of the procedure
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who the procedure was performed on
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of
| |||||||||
| performed[x] |
1..1 | When the procedure was performed
| ||||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| performer |
||||||||||||
| actor |
1..1 | Reference(AU PS Patient | AU PS RelatedPerson | Device - Performer or Observer (IPS) | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) | The reference to the practitioner | |||||||||
| onBehalfOf |
0..1 | Reference(AU PS Organization) | Organization the device or practitioner was acting for | |||||||||
| reasonCode |
0..* | CodeableConceptIPS | Coded reason procedure performed
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation | AU PS Procedure | DocumentReference) | The justification that the procedure was performed
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||
| extension: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 |
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 |
1..1 | CodeableConceptIPS | Identification of the procedure Binding: Procedure (extensible)
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who the procedure was performed on
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of
| |||||||||
| performed[x] |
1..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 PS Patient | AU PS RelatedPerson | Device - Performer or Observer (IPS) | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) | The reference to the practitioner | |||||||||
| onBehalfOf |
0..1 | Reference(AU PS Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
0..1 | Reference(Location) | Where the procedure happened | |||||||||
| reasonCode |
0..* | CodeableConceptIPS | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation | AU PS Procedure | DocumentReference) | The justification that the procedure was performed
| |||||||||
| bodySite |
C | 0..* | CodeableConcept | Target body sites Binding: Body Site (extensible)Constraints: au-core-pro-01 | ||||||||
| 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 | ||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| au-core-pro-01 | error | Procedure.bodySite | If a coded body site is provided, at least one coding 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
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with 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 | |||||||||||
| extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||
| extension: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 |
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 |
1..1 | CodeableConceptIPS | Identification of the procedure Binding: Procedure (extensible)
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who the procedure was performed on
| |||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of
| |||||||||
| performed[x] |
1..1 | When the procedure was performed
| ||||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| reasonCode |
0..* | CodeableConceptIPS | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation | AU PS Procedure | DocumentReference) | The justification that the procedure was performed
| |||||||||
| Documentation for this format | ||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Procedure.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Procedure.code | Base | extensible |
Procedure
|
⏿1.0.2 | tx.hl7.org.au |
| Procedure.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from AUCoreProcedure
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with the profile Procedure (IPS) | |||||||||
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
| |||||||||
| code |
1..1 | CodeableConceptIPS | Identification of the procedure
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who the procedure was performed on
| |||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL
| |||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of
| |||||||||
| performed[x] |
1..1 | When the procedure was performed
| ||||||||||
| performedDateTime |
dateTime | |||||||||||
| performedPeriod |
Period | |||||||||||
| performedString |
string | |||||||||||
| performedAge |
Age | |||||||||||
| performedRange |
Range | |||||||||||
| performer |
||||||||||||
| actor |
1..1 | Reference(AU PS Patient | AU PS RelatedPerson | Device - Performer or Observer (IPS) | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) | The reference to the practitioner | |||||||||
| onBehalfOf |
0..1 | Reference(AU PS Organization) | Organization the device or practitioner was acting for | |||||||||
| reasonCode |
0..* | CodeableConceptIPS | Coded reason procedure performed
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation | AU PS Procedure | DocumentReference) | The justification that the procedure was performed
| |||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Procedure |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:sexParameterForClinicalUse |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||||||
| extension: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 |
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 |
1..1 | CodeableConceptIPS | Identification of the procedure Binding: Procedure (extensible)
| |||||||||
| subject |
1..1 | Reference(AU PS Patient) | Who the procedure was performed on
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
C | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| type |
0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||
| identifier |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||
| display |
0..1 | string | Text alternative for the resource | |||||||||
| encounter |
0..1 | Reference(AU PS Encounter) | Encounter created as part of
| |||||||||
| performed[x] |
1..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 PS Patient | AU PS RelatedPerson | Device - Performer or Observer (IPS) | AU PS Practitioner | AU PS PractitionerRole | AU PS Organization) | The reference to the practitioner | |||||||||
| onBehalfOf |
0..1 | Reference(AU PS Organization) | Organization the device or practitioner was acting for | |||||||||
| location |
0..1 | Reference(Location) | Where the procedure happened | |||||||||
| reasonCode |
0..* | CodeableConceptIPS | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required.
| |||||||||
| reasonReference |
0..* | Reference(AU PS Condition | Observation | AU PS Procedure | DocumentReference) | The justification that the procedure was performed
| |||||||||
| bodySite |
C | 0..* | CodeableConcept | Target body sites Binding: Body Site (extensible)Constraints: au-core-pro-01 | ||||||||
| 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 | ||||||||||||
| Id | Grade | Path(s) | Description | Expression |
| au-core-pro-01 | error | Procedure.bodySite | If a coded body site is provided, at least one coding 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
Mandatory: 2 elements
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-10-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change