AU Core Implementation Guide
0.2.2-preview - Preview
AU Core Implementation Guide
0.2.2-preview - Preview
This page is part of the Australian Core IG (v0.2.2-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-specimen | Version: 0.2.2-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUCoreSpecimen | ||
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 sets minimum expectations for a Specimen resource to record, search, and fetch specimens associated with a patient. It is based on the AU Base Specimen profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Specimen when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
The following are example usage scenarios for this profile:
A resource conforming to this profile:
No equivalent International Patient Access profile.
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Summary or US Core MAY NOT conform to AU Core.
Specimen.collection.collectedDateTime or Specimen.collection.collectedPeriod.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseSpecimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Specimen | 0..* | AUBaseSpecimen | A specimen in an Australian healthcare context | |
  identifier | S | 0..* | Identifier | External Identifier |
| accessionIdentifier | S | 0..1 | Identifier | Identifier assigned by the lab |
| type | S | 1..1 | CodeableConcept | Kind of material that forms the specimen |
 subject | S | 1..1 | Reference(AU Core Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
| request | S | 0..* | Reference(AU Core ServiceRequest) | Why the specimen was collected |
 collection | S | 0..1 | BackboneElement | Collection details |
 collector | S | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole) | Who collected the specimen |
| collected[x] | S | 1..1 | dateTime, Period | Collection time |
| method | S | 0..1 | CodeableConcept | Technique used to perform collection |
| bodySite | SC | 0..1 | CodeableConcept | Anatomical collection site Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-spc-01: If a coded body site is provided, at least one code shall be from SNOMED CT |
 fastingStatus[x] | S | 0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.collection.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-spc-01 | error | Specimen.collection.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen | 0..* | AUBaseSpecimen | A specimen in an Australian healthcare context | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 0..* | Identifier | External Identifier |
| accessionIdentifier | SΣ | 0..1 | Identifier | Identifier assigned by the lab |
| status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
| request | S | 0..* | Reference(AU Core ServiceRequest) | Why the specimen was collected |
| collection | S | 0..1 | BackboneElement | Collection details |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| collector | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole) | Who collected the specimen |
  collected[x] | SΣ | 1..1 | Collection time | |
 collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| method | S | 0..1 | CodeableConcept | Technique used to perform collection Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred) |
| bodySite | SC | 0..1 | CodeableConcept | Anatomical collection site Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-spc-01: If a coded body site is provided, at least one code shall be from SNOMED CT |
| fastingStatus[x] | SΣ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |
| fastingStatusCodeableConcept | CodeableConcept | |||
| fastingStatusDuration | Duration | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.status | required | SpecimenStatus |
| Specimen.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 |
| Specimen.collection.method | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 |
| Specimen.collection.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-spc-01 | error | Specimen.collection.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen | 0..* | AUBaseSpecimen | A specimen 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | External Identifier | ||||
| accessionIdentifier | SΣ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred) | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
| receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
| parent | 0..* | Reference(AU Base Specimen) | Specimen from which this specimen originated | |||||
| request | S | 0..* | Reference(AU Core ServiceRequest) | Why the specimen was collected | ||||
| collection | S | 0..1 | BackboneElement | Collection details | ||||
| 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 | ||||
| collector | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole) | Who collected the specimen | ||||
| collected[x] | SΣ | 1..1 | Collection time | |||||
| collectedDateTime | dateTime | |||||||
| collectedPeriod | Period | |||||||
| duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
| quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
| method | S | 0..1 | CodeableConcept | Technique used to perform collection Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred) | ||||
| bodySite | SC | 0..1 | CodeableConcept | Anatomical collection site Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-spc-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
| fastingStatus[x] | SΣ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
| fastingStatusCodeableConcept | CodeableConcept | |||||||
| fastingStatusDuration | Duration | |||||||
| processing | 0..* | BackboneElement | Processing and processing step details | |||||
| 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 | ||||
| description | 0..1 | string | Textual description of procedure | |||||
| procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
| additive | 0..* | Reference(Substance) | Material used in the processing step | |||||
| time[x] | 0..1 | Date and time of specimen processing | ||||||
| timeDateTime | dateTime | |||||||
| timePeriod | Period | |||||||
| container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
| 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 | ||||
| identifier | Σ | 0..* | Identifier | Id for the container | ||||
| description | 0..1 | string | Textual description of the container | |||||
| type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
| capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
| specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
| additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept | CodeableConcept | |||||||
| additiveReference | Reference(Substance) | |||||||
| condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
| note | 0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Specimen.language | preferred | CommonLanguages
| ||||
| Specimen.status | required | SpecimenStatus | ||||
| Specimen.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 | ||||
| Specimen.collection.method | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 | ||||
| Specimen.collection.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
| Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
| Specimen.container.type | example | SpecimenContainerType | ||||
| Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
| Specimen.condition | extensible | Hl7VSSpecimenCondition |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-spc-01 | error | Specimen.collection.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() |
This structure is derived from AUBaseSpecimen
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUBaseSpecimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen | 0..* | AUBaseSpecimen | A specimen in an Australian healthcare context | |
| identifier | S | 0..* | Identifier | External Identifier |
| accessionIdentifier | S | 0..1 | Identifier | Identifier assigned by the lab |
| type | S | 1..1 | CodeableConcept | Kind of material that forms the specimen |
| subject | S | 1..1 | Reference(AU Core Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
| request | S | 0..* | Reference(AU Core ServiceRequest) | Why the specimen was collected |
| collection | S | 0..1 | BackboneElement | Collection details |
| collector | S | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole) | Who collected the specimen |
| collected[x] | S | 1..1 | dateTime, Period | Collection time |
| method | S | 0..1 | CodeableConcept | Technique used to perform collection |
| bodySite | SC | 0..1 | CodeableConcept | Anatomical collection site Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-spc-01: If a coded body site is provided, at least one code shall be from SNOMED CT |
| fastingStatus[x] | S | 0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.collection.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-spc-01 | error | Specimen.collection.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen | 0..* | AUBaseSpecimen | A specimen in an Australian healthcare context | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | External Identifier |
| accessionIdentifier | SΣ | 0..1 | Identifier | Identifier assigned by the lab |
| status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred) |
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
| request | S | 0..* | Reference(AU Core ServiceRequest) | Why the specimen was collected |
| collection | S | 0..1 | BackboneElement | Collection details |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| collector | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole) | Who collected the specimen |
| collected[x] | SΣ | 1..1 | Collection time | |
| collectedDateTime | dateTime | |||
| collectedPeriod | Period | |||
| method | S | 0..1 | CodeableConcept | Technique used to perform collection Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred) |
| bodySite | SC | 0..1 | CodeableConcept | Anatomical collection site Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-spc-01: If a coded body site is provided, at least one code shall be from SNOMED CT |
| fastingStatus[x] | SΣ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |
| fastingStatusCodeableConcept | CodeableConcept | |||
| fastingStatusDuration | Duration | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Specimen.status | required | SpecimenStatus |
| Specimen.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 |
| Specimen.collection.method | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 |
| Specimen.collection.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-spc-01 | error | Specimen.collection.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen | 0..* | AUBaseSpecimen | A specimen 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | External Identifier | ||||
| accessionIdentifier | SΣ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 (preferred) | ||||
| subject | SΣ | 1..1 | Reference(AU Core Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device | ||||
| receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
| parent | 0..* | Reference(AU Base Specimen) | Specimen from which this specimen originated | |||||
| request | S | 0..* | Reference(AU Core ServiceRequest) | Why the specimen was collected | ||||
| collection | S | 0..1 | BackboneElement | Collection details | ||||
| 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 | ||||
| collector | SΣ | 0..1 | Reference(AU Core Practitioner | AU Core PractitionerRole) | Who collected the specimen | ||||
| collected[x] | SΣ | 1..1 | Collection time | |||||
| collectedDateTime | dateTime | |||||||
| collectedPeriod | Period | |||||||
| duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
| quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
| method | S | 0..1 | CodeableConcept | Technique used to perform collection Binding: https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 (preferred) | ||||
| bodySite | SC | 0..1 | CodeableConcept | Anatomical collection site Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (extensible) au-core-spc-01: If a coded body site is provided, at least one code shall be from SNOMED CT | ||||
| fastingStatus[x] | SΣ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
| fastingStatusCodeableConcept | CodeableConcept | |||||||
| fastingStatusDuration | Duration | |||||||
| processing | 0..* | BackboneElement | Processing and processing step details | |||||
| 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 | ||||
| description | 0..1 | string | Textual description of procedure | |||||
| procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
| additive | 0..* | Reference(Substance) | Material used in the processing step | |||||
| time[x] | 0..1 | Date and time of specimen processing | ||||||
| timeDateTime | dateTime | |||||||
| timePeriod | Period | |||||||
| container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
| 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 | ||||
| identifier | Σ | 0..* | Identifier | Id for the container | ||||
| description | 0..1 | string | Textual description of the container | |||||
| type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
| capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
| specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
| additive[x] | 0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept | CodeableConcept | |||||||
| additiveReference | Reference(Substance) | |||||||
| condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
| note | 0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Specimen.language | preferred | CommonLanguages
| ||||
| Specimen.status | required | SpecimenStatus | ||||
| Specimen.type | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-type-1 | ||||
| Specimen.collection.method | preferred | https://healthterminologies.gov.au/fhir/ValueSet/specimen-collection-procedure-1 | ||||
| Specimen.collection.bodySite | extensible | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 | ||||
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformation | ||||
| Specimen.processing.procedure | example | SpecimenProcessingProcedure | ||||
| Specimen.container.type | example | SpecimenContainerType | ||||
| Specimen.container.additive[x] | example | Hl7VSAdditivePreservative | ||||
| Specimen.condition | extensible | Hl7VSSpecimenCondition |
| Id | Grade | Path(s) | Details | Requirements |
| au-core-spc-01 | error | Specimen.collection.bodySite | If a coded body site is provided, at least one code shall be from SNOMED CT : coding.exists() implies coding.where(system='http://snomed.info/sct').exists() |
This structure is derived from AUBaseSpecimen
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.
| Parameter(s) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| patient | SHALL | reference |
The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. |
| _id | SHOULD | token |
|
| patient.identifier | SHOULD | reference.token |
The client SHALL provide both the system and code values. The server SHALL support both. The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
The following search parameters and search parameter combinations SHALL be supported:
patient search parameter:
_revinclude parameters: Provenance:targetpatient.identifier (e.g. patient.identifier=[system|][code]GET [base]/Specimen?patient={Type/}[id] or optionallyGET [base]/Specimen?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle of all Specimen resources for the specified patient (how to search by reference and how to search by token)
The following search parameter combinations SHOULD be supported:
_id search parameter:
_revinclude parameters: Provenance:target
GET [base]/Specimen/[id] or GET [base]/Specimen?_id=[id]Example:
Implementation Notes: Fetches a single Specimen (how to search by the logical id of the resource)
IG © 2022+ HL7 Australia. Package hl7.fhir.au.core#0.2.2-preview based on FHIR 4.0.1. Generated 2023-11-16
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change