DRAFT AU Patient Summary Implementation Guide for Testing
0.1.0-cibuild - CI Build
DRAFT AU Patient Summary Implementation Guide for Testing, 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-exp-ps-procedure | Version: 0.1.0-cibuild | |||
Standards status: Informative | Computable Name: EXPERIMENTALAUPSProcedure | |||
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, the additional IPS rules are manually applied, and the target references for elements flagged with Must Support changed to EXPERIMENTAL AU PS profiles. This profile is compliant to IPS Procedure profile. For IG Publisher to allow for this profile to be referenced by a Composition profile or Bundle profile that is derived from IPS, some formal declaration is required to be provided otherwise a build error is triggered. At this time compliesWithProfile is used in preference to imposeProfile. This is the expected approach for the HL7 AU Patient Summary FHIR IG.
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: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with the profile Procedure (IPS) | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!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. |
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure ![]() |
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(EXPERIMENTAL AU PS Patient) | Who the procedure was performed on |
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of |
![]() ![]() ![]() |
SOΣ | 1..1 | When the procedure was performed | |
![]() ![]() ![]() ![]() |
dateTime S | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. |
![]() ![]() ![]() |
SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed |
![]() |
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() |
This structure is derived from AUCoreProcedure
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
AUCoreProcedure | This profile also complies with the profile Procedure (IPS) | ||
![]() ![]() ![]() |
1..1 | Reference(EXPERIMENTAL AU PS Patient) | Who the procedure was performed on | |
![]() ![]() ![]() |
1..1 | dateTime, Period, string, Age, Range | When the procedure was performed | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | Reference(EXPERIMENTAL AU PS Patient | EXPERIMENTAL AU PS RelatedPerson | Device - Performer or Observer (IPS) | EXPERIMENTAL AU PS Practitioner | EXPERIMENTAL AU PS PractitionerRole | EXPERIMENTAL AU PS Organization) | The reference to the practitioner | |
![]() ![]() ![]() ![]() |
0..1 | Reference(EXPERIMENTAL AU PS Organization) | Organization the device or practitioner was acting for | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with the profile Procedure (IPS) | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
![]() ![]() ![]() |
?!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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure ![]() | ||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(EXPERIMENTAL AU PS Patient) | Who the procedure was performed on | ||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
SOΣ | 1..1 | When the procedure was performed | |||||
![]() ![]() ![]() ![]() |
dateTime S | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(EXPERIMENTAL AU PS Patient | EXPERIMENTAL AU PS RelatedPerson | Device - Performer or Observer (IPS) | EXPERIMENTAL AU PS Practitioner | EXPERIMENTAL AU PS PractitionerRole | EXPERIMENTAL AU PS Organization) | The reference to the practitioner | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(EXPERIMENTAL AU PS Organization) | Organization the device or practitioner was acting for | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
![]() ![]() ![]() |
SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed | ||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Target body sites Binding: Body Site ![]() Constraints: au-core-pro-01 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
![]() ![]() ![]() |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
![]() ![]() ![]() |
0..* | Annotation | Additional information about the procedure | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Device) | Device that was changed | |||||
![]() ![]() ![]() |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Procedure.language | preferred | CommonLanguageshttp://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 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: 1 element
Structures
This structure refers to these other structures:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with the profile Procedure (IPS) | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!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. |
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure ![]() |
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(EXPERIMENTAL AU PS Patient) | Who the procedure was performed on |
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of |
![]() ![]() ![]() |
SOΣ | 1..1 | When the procedure was performed | |
![]() ![]() ![]() ![]() |
dateTime S | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Age | |||
![]() ![]() ![]() ![]() |
Range | |||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. |
![]() ![]() ![]() |
SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed |
![]() |
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() |
Differential View
This structure is derived from AUCoreProcedure
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
AUCoreProcedure | This profile also complies with the profile Procedure (IPS) | ||
![]() ![]() ![]() |
1..1 | Reference(EXPERIMENTAL AU PS Patient) | Who the procedure was performed on | |
![]() ![]() ![]() |
1..1 | dateTime, Period, string, Age, Range | When the procedure was performed | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | Reference(EXPERIMENTAL AU PS Patient | EXPERIMENTAL AU PS RelatedPerson | Device - Performer or Observer (IPS) | EXPERIMENTAL AU PS Practitioner | EXPERIMENTAL AU PS PractitionerRole | EXPERIMENTAL AU PS Organization) | The reference to the practitioner | |
![]() ![]() ![]() ![]() |
0..1 | Reference(EXPERIMENTAL AU PS Organization) | Organization the device or practitioner was acting for | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AUCoreProcedure | A procedure in an Australian healthcare context This profile also complies with the profile Procedure (IPS) | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..* | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event | ||||
![]() ![]() ![]() |
?!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. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. | ||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: Procedure ![]() | ||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(EXPERIMENTAL AU PS Patient) | Who the procedure was performed on | ||||
![]() ![]() ![]() |
SOΣ | 0..1 | Reference(AU Core Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
SOΣ | 1..1 | When the procedure was performed | |||||
![]() ![]() ![]() ![]() |
dateTime S | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(EXPERIMENTAL AU PS Patient | EXPERIMENTAL AU PS RelatedPerson | Device - Performer or Observer (IPS) | EXPERIMENTAL AU PS Practitioner | EXPERIMENTAL AU PS PractitionerRole | EXPERIMENTAL AU PS Organization) | The reference to the practitioner | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(EXPERIMENTAL AU PS Organization) | Organization the device or practitioner was acting for | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example): A code that identifies the reason a procedure is required. | ||||
![]() ![]() ![]() |
SOΣ | 0..* | Reference(AU Core Condition | Observation | AU Core Procedure | DocumentReference) | The justification that the procedure was performed | ||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Target body sites Binding: Body Site ![]() Constraints: au-core-pro-01 | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
![]() ![]() ![]() |
0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
![]() ![]() ![]() |
0..* | Annotation | Additional information about the procedure | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Device) | Device that was changed | |||||
![]() ![]() ![]() |
0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Procedure.language | preferred | CommonLanguageshttp://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 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: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron