Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions
Resource Profile: SupplyRequest
| Official URL: https://ancode.app/fhir/StructureDefinition/SupplyRequest | Version: 0.2.0 | |||
| Draft as of 2022-12-21 | Computable Name: SupplyRequest | |||
Usage:
- This Resource Profile is not used by any profiles in this Implementation Guide
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SupplyRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  deliverWhen | 0..1 | date | Extension URL: https://ancode.app/fhir/StructureDefinition/Date | |
   value[x] | 0..1 | date | Value of extension | |
  item[x] | 1..1 | Medication, Substance, or Device requested to be supplied | ||
  itemCodeableConcept | CodeableConcept | |||
  itemReference | Reference(Medication | Substance | Device | DeviceDefinition) | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deliverWhen | 0..1 | date | Extension URL: https://ancode.app/fhir/StructureDefinition/Date | |
 url | 1..1 | uri | "https://ancode.app/fhir/StructureDefinition/Date" | |
| value[x] | 0..1 | date | Value of extension | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 0..1 | code | draft | active | suspended + Binding: SupplyRequestStatus (required): Status of the supply request. |
| item[x] | Σ | 1..1 | Medication, Substance, or Device requested to be supplied Binding: SNOMEDCTSupplyItem (example): The item that was requested. | |
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Medication | Substance | Device | DeviceDefinition) | |||
| quantity | Σ | 1..1 | Quantity | The requested amount of the item indicated |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| SupplyRequest.status | required | SupplyRequestStatus |
| SupplyRequest.item[x] | example | SNOMEDCTSupplyItem |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | SupplyRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | SupplyRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | SupplyRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |||||
| 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deliverWhen | 0..1 | date | Extension URL: https://ancode.app/fhir/StructureDefinition/Date | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "https://ancode.app/fhir/StructureDefinition/Date" | |||||
| value[x] | 0..1 | date | Value of extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for SupplyRequest | ||||
| status | ?!Σ | 0..1 | code | draft | active | suspended + Binding: SupplyRequestStatus (required): Status of the supply request. | ||||
| category | Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc.) Binding: SupplyType (example): Category of supply request. | ||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| item[x] | Σ | 1..1 | Medication, Substance, or Device requested to be supplied Binding: SNOMEDCTSupplyItem (example): The item that was requested. | |||||
| itemCodeableConcept | CodeableConcept | |||||||
| itemReference | Reference(Medication | Substance | Device | DeviceDefinition) | |||||||
| quantity | Σ | 1..1 | Quantity | The requested amount of the item indicated | ||||
| parameter | 0..* | BackboneElement | Ordered item 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 | ||||
| code | 0..1 | CodeableConcept | Item detail Binding: (unbound) (example): A code that identifies the device detail. | |||||
| value[x] | 0..1 | Value of detail | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueBoolean | boolean | |||||||
| occurrence[x] | Σ | 0..1 | When the request should be fulfilled | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| occurrenceTiming | Timing | |||||||
| authoredOn | Σ | 0..1 | dateTime | When the request was made | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Individual making the request | ||||
| supplier | Σ | 0..* | Reference(Organization | HealthcareService) | Who is intended to fulfill the request | ||||
| reasonCode | 0..* | CodeableConcept | The reason why the supply item was requested Binding: SupplyRequestReason (example): The reason why the supply item was requested. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | The reason why the supply item was requested | |||||
| deliverFrom | 0..1 | Reference(Organization | Location) | The origin of the supply | |||||
| deliverTo | 0..1 | Reference(Organization | Location | Patient) | The destination of the supply | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| SupplyRequest.language | preferred | CommonLanguages
| ||||
| SupplyRequest.status | required | SupplyRequestStatus | ||||
| SupplyRequest.category | example | SupplyType | ||||
| SupplyRequest.priority | required | RequestPriority | ||||
| SupplyRequest.item[x] | example | SNOMEDCTSupplyItem | ||||
| SupplyRequest.parameter.code | example | |||||
| SupplyRequest.reasonCode | example | SupplyRequestReason |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | SupplyRequest.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from SupplyRequest
Differential View
This structure is derived from SupplyRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deliverWhen | 0..1 | date | Extension URL: https://ancode.app/fhir/StructureDefinition/Date | |
| value[x] | 0..1 | date | Value of extension | |
| item[x] | 1..1 | Medication, Substance, or Device requested to be supplied | ||
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Medication | Substance | Device | DeviceDefinition) | |||
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| deliverWhen | 0..1 | date | Extension URL: https://ancode.app/fhir/StructureDefinition/Date | |
| url | 1..1 | uri | "https://ancode.app/fhir/StructureDefinition/Date" | |
| value[x] | 0..1 | date | Value of extension | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 0..1 | code | draft | active | suspended + Binding: SupplyRequestStatus (required): Status of the supply request. |
| item[x] | Σ | 1..1 | Medication, Substance, or Device requested to be supplied Binding: SNOMEDCTSupplyItem (example): The item that was requested. | |
| itemCodeableConcept | CodeableConcept | |||
| itemReference | Reference(Medication | Substance | Device | DeviceDefinition) | |||
| quantity | Σ | 1..1 | Quantity | The requested amount of the item indicated |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| SupplyRequest.status | required | SupplyRequestStatus |
| SupplyRequest.item[x] | example | SNOMEDCTSupplyItem |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | SupplyRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | SupplyRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | SupplyRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | SupplyRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| SupplyRequest | 0..* | SupplyRequest | Request for a medication, substance or device | |||||
| 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| deliverWhen | 0..1 | date | Extension URL: https://ancode.app/fhir/StructureDefinition/Date | |||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "https://ancode.app/fhir/StructureDefinition/Date" | |||||
| value[x] | 0..1 | date | Value of extension | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Business Identifier for SupplyRequest | ||||
| status | ?!Σ | 0..1 | code | draft | active | suspended + Binding: SupplyRequestStatus (required): Status of the supply request. | ||||
| category | Σ | 0..1 | CodeableConcept | The kind of supply (central, non-stock, etc.) Binding: SupplyType (example): Category of supply request. | ||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| item[x] | Σ | 1..1 | Medication, Substance, or Device requested to be supplied Binding: SNOMEDCTSupplyItem (example): The item that was requested. | |||||
| itemCodeableConcept | CodeableConcept | |||||||
| itemReference | Reference(Medication | Substance | Device | DeviceDefinition) | |||||||
| quantity | Σ | 1..1 | Quantity | The requested amount of the item indicated | ||||
| parameter | 0..* | BackboneElement | Ordered item 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 | ||||
| code | 0..1 | CodeableConcept | Item detail Binding: (unbound) (example): A code that identifies the device detail. | |||||
| value[x] | 0..1 | Value of detail | ||||||
| valueCodeableConcept | CodeableConcept | |||||||
| valueQuantity | Quantity | |||||||
| valueRange | Range | |||||||
| valueBoolean | boolean | |||||||
| occurrence[x] | Σ | 0..1 | When the request should be fulfilled | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| occurrenceTiming | Timing | |||||||
| authoredOn | Σ | 0..1 | dateTime | When the request was made | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Individual making the request | ||||
| supplier | Σ | 0..* | Reference(Organization | HealthcareService) | Who is intended to fulfill the request | ||||
| reasonCode | 0..* | CodeableConcept | The reason why the supply item was requested Binding: SupplyRequestReason (example): The reason why the supply item was requested. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | The reason why the supply item was requested | |||||
| deliverFrom | 0..1 | Reference(Organization | Location) | The origin of the supply | |||||
| deliverTo | 0..1 | Reference(Organization | Location | Patient) | The destination of the supply | |||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| SupplyRequest.language | preferred | CommonLanguages
| ||||
| SupplyRequest.status | required | SupplyRequestStatus | ||||
| SupplyRequest.category | example | SupplyType | ||||
| SupplyRequest.priority | required | RequestPriority | ||||
| SupplyRequest.item[x] | example | SNOMEDCTSupplyItem | ||||
| SupplyRequest.parameter.code | example | |||||
| SupplyRequest.reasonCode | example | SupplyRequestReason |
Constraints
| Id | Grade | Path(s) | Details | Requirements |
| dom-r4b | warning | SupplyRequest.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from SupplyRequest
Other representations of profile: CSV, Excel, Schematron