Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
DRAFT
ONLY
AU Base Diagnostic Procedure Request [FMM Level 0]
This profile defines a procedure request structure that includes core localisation concepts for use as a diagnostic procedure request in an Australian context.
Note: The targetBodySite extension should only be used if not implicit in the code found in ProcedureRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedurerequest-targetBodySite.
Forthcoming work around this profile is expected to result in a value set representing the Standard for Pathology Informatics in Australia - Requesting codes bound as a slice on the code element in addition to the existing slice for diagnostic imaging requests in SNOMED CTTM.
These definitions represent common data held in the ProcedureRequest.identifier element:
Extensions used in this profile:
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-diagnosticprocedurerequest
This profile defines a procedure request structure that includes core localisation concepts for use as a diagnostic procedure request in an Australian context.
This profile builds on ProcedureRequest.
This profile was published on Wed Jan 22 10:17:54 AEDT 2020 as a draft by Health Level Seven Australia (Orders and Observations WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ProcedureRequest | I | 0..* | ProcedureRequest | A diagnostic procedure request in an Australian healthcare context |
  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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 performer-party | I | 0..* | Reference(PractitionerRole | CareTeam) | Performing practitioner role or care team URL: http://hl7.org.au/fhir/StructureDefinition/performer-party |
| procedurerequest-targetBodySite | I | 0..* | Reference(BodySite) | The requested target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-targetBodySite |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 0..* | (Slice Definition) | Identifiers assigned to this order Slice: Unordered, Open by pattern:type |
  identifier:placerIdentifier | Σ | 0..* | Identifier | Placer identifier |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (required) |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| display | 0..1 | string | Representation defined by the system | |
 userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | Σ | 1..1 | uri | Placer identifier system namespace Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Placer identifier Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | Protocol or definition |
| basedOn | Σ | 0..* | Reference(Resource) | What request fulfills |
| replaces | Σ | 0..* | Reference(Resource) | What request replaces |
| requisition | Σ | 0..1 | Identifier | Composite Request ID |
| status | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order + Binding: RequestIntent (required) |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| doNotPerform | ?!Σ | 0..1 | boolean | True if procedure should not be performed |
| category | Σ | 0..* | CodeableConcept | Classification of procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
| code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure Codes (SNOMED CT) (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
| coding:snomedImagingProcedure | Σ | 0..1 | Coding | Imaging Procedure (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual the service is ordered for |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which request was created |
 occurrence[x] | Σ | 0..1 | When procedure should occur | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| asNeeded[x] | Σ | 0..1 | Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
| asNeededBoolean | boolean | |||
| asNeededCodeableConcept | CodeableConcept | |||
| authoredOn | Σ | 0..1 | dateTime | Date request signed |
| requester | ΣI | 0..1 | BackboneElement | Who/what is requesting procedure or diagnostic |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| agent | Σ | 1..1 | Reference(Device | Practitioner | Organization) | Individual making the request |
| onBehalfOf | Σ | 0..1 | Reference(Organization) | Organization agent is acting for |
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Participant Roles (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
 coding:anzscoPerformerType | Σ | 0..1 | Coding | Australian and New Zealand Standard Classification of Occupations Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required) |
| coding:snomedPerformerType | Σ | 0..1 | Coding | Practitioner Role (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| performer | Σ | 0..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService) | Requested perfomer |
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for test Binding: Procedure Reason Codes (example) |
| reasonReference | Σ | 0..* | Reference(Condition | Observation) | Explanation/Justification for test |
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples |
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMED CT Body Structures (example) |
| note | 0..* | Annotation | Comments | |
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ProcedureRequest | I | 0..* | ProcedureRequest | A diagnostic procedure request in an Australian healthcare context |
| 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| performer-party | I | 0..* | Reference(PractitionerRole | CareTeam) | Performing practitioner role or care team URL: http://hl7.org.au/fhir/StructureDefinition/performer-party |
| procedurerequest-targetBodySite | I | 0..* | Reference(BodySite) | The requested target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedurerequest-targetBodySite |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..* | (Slice Definition) | Identifiers assigned to this order Slice: Unordered, Open by pattern:type |
| identifier:placerIdentifier | Σ | 0..* | Identifier | Placer identifier |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: v2 Identifier Type - AU Extended (required) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/identifier-type | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| system | Σ | 1..1 | uri | Placer identifier system namespace Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | Placer identifier Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| definition | Σ | 0..* | Reference(ActivityDefinition | PlanDefinition) | Protocol or definition |
| basedOn | Σ | 0..* | Reference(Resource) | What request fulfills |
| replaces | Σ | 0..* | Reference(Resource) | What request replaces |
| requisition | Σ | 0..1 | Identifier | Composite Request ID |
| status | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled Binding: RequestStatus (required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order + Binding: RequestIntent (required) |
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
| doNotPerform | ?!Σ | 0..1 | boolean | True if procedure should not be performed |
| category | Σ | 0..* | CodeableConcept | Classification of procedure Binding: Procedure Category Codes (SNOMED CT) (example) |
| code | Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure Codes (SNOMED CT) (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system, value:code |
| coding:snomedImagingProcedure | Σ | 0..1 | Coding | Imaging Procedure (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/imaging-procedure-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual the service is ordered for |
| context | Σ | 0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode during which request was created |
| occurrence[x] | Σ | 0..1 | When procedure should occur | |
| occurrenceDateTime | dateTime | |||
| occurrencePeriod | Period | |||
| occurrenceTiming | Timing | |||
| asNeeded[x] | Σ | 0..1 | Preconditions for procedure or diagnostic Binding: SNOMED CT Medication As Needed Reason Codes (example) | |
| asNeededBoolean | boolean | |||
| asNeededCodeableConcept | CodeableConcept | |||
| authoredOn | Σ | 0..1 | dateTime | Date request signed |
| requester | ΣI | 0..1 | BackboneElement | Who/what is requesting procedure or diagnostic |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| agent | Σ | 1..1 | Reference(Device | Practitioner | Organization) | Individual making the request |
| onBehalfOf | Σ | 0..1 | Reference(Organization) | Organization agent is acting for |
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Participant Roles (example) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:anzscoPerformerType | Σ | 0..1 | Coding | Australian and New Zealand Standard Classification of Occupations Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required) |
| coding:snomedPerformerType | Σ | 0..1 | Coding | Practitioner Role (SNOMED CT) Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| performer | Σ | 0..1 | Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService) | Requested perfomer |
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for test Binding: Procedure Reason Codes (example) |
| reasonReference | Σ | 0..* | Reference(Condition | Observation) | Explanation/Justification for test |
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples |
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMED CT Body Structures (example) |
| note | 0..* | Annotation | Comments | |
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-diagnosticprocedurerequest
none defined
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
