Order Catalog Implementation Guide
current - CI Build
Order Catalog Implementation Guide
current - CI Build
Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions
| Draft as of 2020-06-08 |
Definitions for the SpecimenRequested extension.
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| 2. Extension.extension | |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are and , and can be differentiated using the following discriminators:
|
| 3. Extension.extension:ExclusiveGroup | |
| SliceName | ExclusiveGroup |
| Definition | A group of specimens requested that must all be provided in case this group is chosen at specimen collection time. |
| Control | 1..? |
| Comments | In case multiple groups are defined, these groups are mutually exclusive: one and only one group must be chosen at specimen collection time. |
| 4. Extension.extension:ExclusiveGroup.extension | |
| Control | 0..? |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. Extension.extension:ExclusiveGroup.extension:Material | |
| SliceName | Material |
| Definition | A reference to a SpecimenDefinition resource representing the material |
| Control | 1..? |
| Comments | When multiple materials are present under an exclusive group, all are requested. |
| 6. Extension.extension:ExclusiveGroup.extension:Material.url | |
| Control | 0..? |
| Fixed Value | Material |
| 7. Extension.extension:ExclusiveGroup.extension:Material.value[x] | |
| Definition | A reference to SpecimenDefinition as constrained by the LabSpecimenDefinition profile |
| Control | 0..? |
| Type | Reference(LabSpecimenDefinition) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 8. Extension.extension:ExclusiveGroup.url | |
| Control | 0..? |
| Fixed Value | ExclusiveGroup |
| 9. Extension.extension:ExclusiveGroup.value[x] | |
| Control | 0..0 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 10. Extension.url | |
| Fixed Value | http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested |
| 11. Extension.value[x] | |
| Control | 0..01 |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | An Extension Optional Extension Element - found in all resources. |
| Control | 0..* |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 2. Extension.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 3. Extension.extension:ExclusiveGroup | |
| SliceName | ExclusiveGroup |
| Definition | A group of specimens requested that must all be provided in case this group is chosen at specimen collection time. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 10..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | In case multiple groups are defined, these groups are mutually exclusive: one and only one group must be chosen at specimen collection time. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 4. Extension.extension:ExclusiveGroup.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. Extension.extension:ExclusiveGroup.extension:Material | |
| SliceName | Material |
| Definition | A reference to a SpecimenDefinition resource representing the material May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 10..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | When multiple materials are present under an exclusive group, all are requested. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 6. Extension.extension:ExclusiveGroup.extension:Material.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | Material |
| 7. Extension.extension:ExclusiveGroup.extension:Material.value[x] | |
| Definition | A reference to SpecimenDefinition as constrained by the LabSpecimenDefinition profile Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..1 This element is affected by the following invariants: ext-1 |
| Type | Choice of: Reference(LabSpecimenDefinition), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, RatioRange, Coding, SampledData, id, positiveInt, Distance, Availability, integer64, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ExtendedContactDetail, CodeableConcept, ParameterDefinition, dateTime, code, string, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, CodeableReference, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 8. Extension.extension:ExclusiveGroup.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | ExclusiveGroup |
| 9. Extension.extension:ExclusiveGroup.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..01 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested |
| 11. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..01 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here.
| 1. Extension | |
| Definition | An Extension |
| Control | 0..* |
| 2. Extension.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 3. Extension.extension | |
| Definition | An Extension |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Extension.extension:ExclusiveGroup | |
| SliceName | ExclusiveGroup |
| Definition | A group of specimens requested that must all be provided in case this group is chosen at specimen collection time. |
| Control | 1..* |
| Type | Extension |
| Summary | false |
| Comments | In case multiple groups are defined, these groups are mutually exclusive: one and only one group must be chosen at specimen collection time. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 5. Extension.extension:ExclusiveGroup.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. Extension.extension:ExclusiveGroup.extension | |
| Definition | An Extension |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 7. Extension.extension:ExclusiveGroup.extension:Material | |
| SliceName | Material |
| Definition | A reference to a SpecimenDefinition resource representing the material |
| Control | 1..* |
| Type | Extension |
| Summary | false |
| Comments | When multiple materials are present under an exclusive group, all are requested. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| 8. Extension.extension:ExclusiveGroup.extension:Material.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | id |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 9. Extension.extension:ExclusiveGroup.extension:Material.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Summary | false |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Extension.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 10. Extension.extension:ExclusiveGroup.extension:Material.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | Material |
| 11. Extension.extension:ExclusiveGroup.extension:Material.value[x] | |
| Definition | A reference to SpecimenDefinition as constrained by the LabSpecimenDefinition profile |
| Control | 0..1 This element is affected by the following invariants: ext-1 |
| Type | Reference(LabSpecimenDefinition) |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. Extension.extension:ExclusiveGroup.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | ExclusiveGroup |
| 13. Extension.extension:ExclusiveGroup.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..0 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 14. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| Summary | false |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Fixed Value | http://hl7.org/fhir/uv/order-catalog/StructureDefinition/SpecimenRequested |
| 15. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 0..0 This element is affected by the following invariants: ext-1 |
| Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference, SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | false |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
IG © 2021+ HL7 International - Orders and Observations Work Group. Package hl7.fhir.uv.order-catalog#current based on FHIR 5.0.0. Generated 2023-07-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change