Supply of Products for Healthcare (SUPPLY)
0.3.0 - ci-build International flag

Supply of Products for Healthcare (SUPPLY), published by IHE Pharmacy Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/pharm-supply/ and changes regularly. See the Directory of published versions

Logical Model: SupplyRequestStatusModel - Detailed Descriptions

Draft as of 2022-12-27

Definitions for the SupplyRequestStatusModel logical model.

Guidance on how to interpret the contents of this table can be found here

0. SupplyRequestStatusModel
Definition

This is the logical model for the Supply Request Status

ShortA request for supply of one or more healthcare products
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SupplyRequestStatusModel.identifier
Definition

identifier

Shortidentifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
4. SupplyRequestStatusModel.status
Definition

code

Shortcode
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SupplyRequestStatusModel.type
Definition

type of request - e.g. type of distribution, priority, etc.

Shorttype of request - e.g. type of distribution, priority, etc.
Control0..1
TypeCodeableConcept
8. SupplyRequestStatusModel.dateTime
Definition

date time

Shortdate time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SupplyRequestStatusModel.requester
Definition

requester

Shortrequester
Control0..1
TypeReference
12. SupplyRequestStatusModel.filler
Definition

performer

Shortperformer
Control0..1
TypeReference
14. SupplyRequestStatusModel.item
Definition

item

Shortitem
Control1..*
TypeBackboneElement
16. SupplyRequestStatusModel.item.itemreference[x]
Definition

item reference

Shortitem reference
Control1..1
TypeChoice of: Reference, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
18. SupplyRequestStatusModel.item.quantity
Definition

quantity

Shortquantity
Control1..*
TypeQuantity
20. SupplyRequestStatusModel.item.originLocation
Definition

origin location

Shortorigin location
Control0..*
TypeReference
22. SupplyRequestStatusModel.destinationLocation
Definition

destination location

Shortdestination location
Control0..*
TypeReference
24. SupplyRequestStatusModel.additionalInfo[x]
Definition

Additional information about the request - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the request
Control0..*
TypeChoice of: Reference, Annotation
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]

Guidance on how to interpret the contents of this table can be found here

0. SupplyRequestStatusModel
Definition

This is the logical model for the Supply Request Status


Base definition for all elements in a resource.

ShortA request for supply of one or more healthcare productsBase for all elements
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SupplyRequestStatusModel.identifier
Definition

identifier

Shortidentifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
4. SupplyRequestStatusModel.status
Definition

code

Shortcode
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SupplyRequestStatusModel.type
Definition

type of request - e.g. type of distribution, priority, etc.

Shorttype of request - e.g. type of distribution, priority, etc.
Control0..1
TypeCodeableConcept
8. SupplyRequestStatusModel.dateTime
Definition

date time

Shortdate time
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SupplyRequestStatusModel.requester
Definition

requester

Shortrequester
Control0..1
TypeReference
12. SupplyRequestStatusModel.filler
Definition

performer

Shortperformer
Control0..1
TypeReference
14. SupplyRequestStatusModel.item
Definition

item

Shortitem
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. SupplyRequestStatusModel.item.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-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())
18. SupplyRequestStatusModel.item.itemreference[x]
Definition

item reference

Shortitem reference
Control1..1
TypeChoice of: Reference, CodeableConcept
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
20. SupplyRequestStatusModel.item.quantity
Definition

quantity

Shortquantity
Control1..*
TypeQuantity
22. SupplyRequestStatusModel.item.originLocation
Definition

origin location

Shortorigin location
Control0..*
TypeReference
24. SupplyRequestStatusModel.destinationLocation
Definition

destination location

Shortdestination location
Control0..*
TypeReference
26. SupplyRequestStatusModel.additionalInfo[x]
Definition

Additional information about the request - this can be relevant history, any remarks by the patient or professional, etc.

ShortAdditional information about the request
Control0..*
TypeChoice of: Reference, Annotation
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]

Guidance on how to interpret the contents of this table can be found here

0. SupplyRequestStatusModel
Definition

This is the logical model for the Supply Request Status

ShortA request for supply of one or more healthcare products
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SupplyRequestStatusModel.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. SupplyRequestStatusModel.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.

ShortAdditional content defined by implementations
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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on SupplyRequestStatusModel.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. SupplyRequestStatusModel.identifier
    Definition

    identifier

    Shortidentifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier
    8. SupplyRequestStatusModel.status
    Definition

    code

    Shortcode
    Control1..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. SupplyRequestStatusModel.type
    Definition

    type of request - e.g. type of distribution, priority, etc.

    Shorttype of request - e.g. type of distribution, priority, etc.
    Control0..1
    TypeCodeableConcept
    12. SupplyRequestStatusModel.dateTime
    Definition

    date time

    Shortdate time
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. SupplyRequestStatusModel.requester
    Definition

    requester

    Shortrequester
    Control0..1
    TypeReference
    16. SupplyRequestStatusModel.filler
    Definition

    performer

    Shortperformer
    Control0..1
    TypeReference
    18. SupplyRequestStatusModel.item
    Definition

    item

    Shortitem
    Control1..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. SupplyRequestStatusModel.item.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typeid
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    22. SupplyRequestStatusModel.item.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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on SupplyRequestStatusModel.item.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. SupplyRequestStatusModel.item.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-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())
      26. SupplyRequestStatusModel.item.itemreference[x]
      Definition

      item reference

      Shortitem reference
      Control1..1
      TypeChoice of: Reference, CodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      28. SupplyRequestStatusModel.item.quantity
      Definition

      quantity

      Shortquantity
      Control1..*
      TypeQuantity
      30. SupplyRequestStatusModel.item.originLocation
      Definition

      origin location

      Shortorigin location
      Control0..*
      TypeReference
      32. SupplyRequestStatusModel.destinationLocation
      Definition

      destination location

      Shortdestination location
      Control0..*
      TypeReference
      34. SupplyRequestStatusModel.additionalInfo[x]
      Definition

      Additional information about the request - this can be relevant history, any remarks by the patient or professional, etc.

      ShortAdditional information about the request
      Control0..*
      TypeChoice of: Reference, Annotation
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]