AU Primary Care Implementation Guide - Local Development build (vnull). See the Directory of published versions
1.0 StructureDefinition-au-primarycareprocedure
AU Primary Care Procedure Profile [FMM Level 0]
This profile defines a procedure structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.
Examples thanks to Brett Esler - Oridashi .. not yet checked for conformance to this IG
1.0.1
Formal Views of Profile Content
The official URL for this profile is:
https://aehrc.com/fhir/StructureDefinition/AUPrimaryCareProcedure
This profile defines a procedure structure that includes core localisation concepts for use in an Australian primary care practice-to-practice record transfer context.
This profile builds on Procedure.
This profile was published on Wed Nov 06 14:07:15 AEST 2019 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Procedure | 0..* | |||
 code | S | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred) |
| performed[x] | S | 0..1 | dateTime, Period, string, Age, Range | |
| bodySite | S | 0..* | CodeableConcept | Binding: (unbound) (preferred) |
 note | 0..* | Annotation | ||
 text | S | 1..1 | markdown | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | An action that is being or was performed on a patient | |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External Identifiers for this procedure |
| instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
 basedOn | ΣI | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure |
| partOf | ΣI | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event |
| status | ?!ΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| statusReason | ΣI | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example) |
| category | ΣI | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) |
| code | SΣI | 0..1 | CodeableConcept | Identification of the procedure Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred) |
| subject | ΣI | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| encounter | ΣI | 0..1 | Reference(Encounter) | Encounter created as part of |
 performed[x] | SΣI | 0..1 | When the procedure was performed | |
 performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| performedString | string | |||
| performedAge | Age | |||
| performedRange | Range | |||
| recorder | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure |
| asserter | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure |
| performer | ΣI | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example) |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| onBehalfOf | I | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for |
| location | ΣI | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode | ΣI | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed |
| bodySite | SΣI | 0..* | CodeableConcept | Target body sites Binding: (unbound) (preferred) |
| outcome | ΣI | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example) |
| report | I | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure |
| complication | I | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example) |
| complicationDetail | I | 0..* | Reference(Condition) | A condition that is a result of the procedure |
| followUp | I | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example) |
| note | I | 0..* | Annotation | Additional information about the procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| author[x] | ΣI | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
| authorString | string | |||
| time | ΣI | 0..1 | dateTime | When the annotation was made |
| text | SΣI | 1..1 | markdown | The annotation - text content (as markdown) |
| focalDevice | I | 0..* | BackboneElement | Manipulated, implanted, or removed device |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| action | I | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred) |
| manipulated | I | 1..1 | Reference(Device) | Device that was changed |
| usedReference | I | 0..* | Reference(Device | Medication | Substance) | Items used during procedure |
| usedCode | I | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example) |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | 0..* | |||
| code | S | 0..1 | CodeableConcept | Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred) |
| performed[x] | S | 0..1 | dateTime, Period, string, Age, Range | |
| bodySite | S | 0..* | CodeableConcept | Binding: (unbound) (preferred) |
| note | 0..* | Annotation | ||
| text | S | 1..1 | markdown | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure | I | 0..* | An action that is being or was performed on a patient | |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..* | Identifier | External Identifiers for this procedure |
| instantiatesCanonical | ΣI | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition |
| instantiatesUri | ΣI | 0..* | uri | Instantiates external protocol or definition |
| basedOn | ΣI | 0..* | Reference(CarePlan | ServiceRequest) | A request for this procedure |
| partOf | ΣI | 0..* | Reference(Procedure | Observation | MedicationAdministration) | Part of referenced event |
| status | ?!ΣI | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) |
| statusReason | ΣI | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example) |
| category | ΣI | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example) |
| code | SΣI | 0..1 | CodeableConcept | Identification of the procedure Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred) |
| subject | ΣI | 1..1 | Reference(Patient | Group) | Who the procedure was performed on |
| encounter | ΣI | 0..1 | Reference(Encounter) | Encounter created as part of |
| performed[x] | SΣI | 0..1 | When the procedure was performed | |
| performedDateTime | dateTime | |||
| performedPeriod | Period | |||
| performedString | string | |||
| performedAge | Age | |||
| performedRange | Range | |||
| recorder | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure |
| asserter | ΣI | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure |
| performer | ΣI | 0..* | BackboneElement | The people who performed the procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example) |
| actor | ΣI | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner |
| onBehalfOf | I | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for |
| location | ΣI | 0..1 | Reference(Location) | Where the procedure happened |
| reasonCode | ΣI | 0..* | CodeableConcept | Coded reason procedure performed Binding: ProcedureReasonCodes (example) |
| reasonReference | ΣI | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed |
| bodySite | SΣI | 0..* | CodeableConcept | Target body sites Binding: (unbound) (preferred) |
| outcome | ΣI | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example) |
| report | I | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure |
| complication | I | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example) |
| complicationDetail | I | 0..* | Reference(Condition) | A condition that is a result of the procedure |
| followUp | I | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example) |
| note | I | 0..* | Annotation | Additional information about the procedure |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| author[x] | ΣI | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||
| authorString | string | |||
| time | ΣI | 0..1 | dateTime | When the annotation was made |
| text | SΣI | 1..1 | markdown | The annotation - text content (as markdown) |
| focalDevice | I | 0..* | BackboneElement | Manipulated, implanted, or removed device |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| action | I | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred) |
| manipulated | I | 1..1 | Reference(Device) | Device that was changed |
| usedReference | I | 0..* | Reference(Device | Medication | Substance) | Items used during procedure |
| usedCode | I | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example) |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
1.0.2 Quick Start
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-primarycareprocedure
none defined
