| Package | ihe.pharm.supply |
| Type | StructureDefinition |
| Id | ReceiptNoticeModel |
| FHIR Version | R5 |
| Source | http://profiles.ihe.net/PHARM/supply/https://build.fhir.org/ig/IHE/pharm-supply/StructureDefinition-ReceiptNoticeModel.html |
| URL | http://profiles.ihe.net/PHARM/supply/StructureDefinition/ReceiptNoticeModel |
| Version | 0.3.0 |
| Status | draft |
| Date | 2022-12-27T13:18:13+01:00 |
| Name | ReceiptNoticeModel |
| Realm | uv |
| Authority | ihe |
| Description | This is the logical model for the ReceiptNotice |
| Copyright | IHE http://www.ihe.net/Governance/#Intellectual_Property |
| Type | http://profiles.ihe.net/PHARM/supply/StructureDefinition/ReceiptNoticeModel |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ReceiptNoticeModel | 0..* | Element | Elements defined in Ancestors:@id, extension A request for supply of one or more healthcare products Instances of this logical model are not marked to be the target of a Reference | |
  identifier | 0..1 | Identifier | Shipment identifier | |
 status | 1..1 | code | status | |
| dateTime | 0..1 | dateTime | date time | |
| requestIdentifier | 0..1 | Identifier | Request identifier | |
 supplier | 0..1 | Reference() | Supplier | |
 supplierLocation | 0..1 | Location | Supplier location | |
| receiver | 0..1 | Reference() | Receiver | |
| receiverLocation | 0..1 | Location | receiver location | |
| item | 1..* | BackboneElement | item | |
  itemreference[x] | 1..1 | item reference | ||
| itemreferenceReference | Reference(Any) | |||
 itemreferenceCodeableConcept | CodeableConcept | |||
| quantity | 1..1 | Quantity | quantity | |
| additionalInfo[x] | 0..* | Additional information about the delivery | ||
 additionalInfoReference | Reference(Any) | |||
| additionalInfoAnnotation | Annotation | |||
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "ReceiptNoticeModel",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://profiles.ihe.net/PHARM/supply/StructureDefinition/ReceiptNoticeModel",
"version": "0.3.0",
"name": "ReceiptNoticeModel",
"status": "draft",
"date": "2022-12-27T13:18:13+01:00",
"publisher": "IHE Pharmacy Technical Committee",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "https://www.ihe.net/ihe_domains/pharmacy/"
}
]
},
{
"telecom": [
{
"system": "email",
"value": "pharmacy@ihe.net"
}
]
},
{
"name": "IHE Pharmacy Technical Committee",
"telecom": [
{
"system": "email",
"value": "pharmacy@ihe.net"
}
]
}
],
"description": "This is the logical model for the ReceiptNotice",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://profiles.ihe.net/PHARM/supply/StructureDefinition/ReceiptNoticeModel",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ReceiptNoticeModel",
"path": "ReceiptNoticeModel",
"short": "A request for supply of one or more healthcare products",
"definition": "This is the logical model for the ReceiptNotice",
"min": 0,
"max": "*",
"base": {
"path": "Element",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ReceiptNoticeModel.id",
"path": "ReceiptNoticeModel.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ReceiptNoticeModel.extension",
"path": "ReceiptNoticeModel.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ReceiptNoticeModel.identifier",
"path": "ReceiptNoticeModel.identifier",
"short": "Shipment identifier",
"definition": "Shipment identifier",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "ReceiptNoticeModel.status",
"path": "ReceiptNoticeModel.status",
"short": "status",
"definition": "status",
"min": 1,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "ReceiptNoticeModel.dateTime",
"path": "ReceiptNoticeModel.dateTime",
"short": "date time",
"definition": "date time",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.dateTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "ReceiptNoticeModel.requestIdentifier",
"path": "ReceiptNoticeModel.requestIdentifier",
"short": "Request identifier",
"definition": "Request identifier",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.requestIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "ReceiptNoticeModel.supplier",
"path": "ReceiptNoticeModel.supplier",
"short": "Supplier",
"definition": "Supplier",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.supplier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference"
}
]
},
{
"id": "ReceiptNoticeModel.supplierLocation",
"path": "ReceiptNoticeModel.supplierLocation",
"short": "Supplier location",
"definition": "Supplier location",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.supplierLocation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Location"
}
]
},
{
"id": "ReceiptNoticeModel.receiver",
"path": "ReceiptNoticeModel.receiver",
"short": "Receiver",
"definition": "Receiver",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.receiver",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference"
}
]
},
{
"id": "ReceiptNoticeModel.receiverLocation",
"path": "ReceiptNoticeModel.receiverLocation",
"short": "receiver location",
"definition": "receiver location",
"min": 0,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.receiverLocation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Location"
}
]
},
{
"id": "ReceiptNoticeModel.item",
"path": "ReceiptNoticeModel.item",
"short": "item",
"definition": "item",
"min": 1,
"max": "*",
"base": {
"path": "ReceiptNoticeModel.item",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "ReceiptNoticeModel.item.id",
"path": "ReceiptNoticeModel.item.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ReceiptNoticeModel.item.extension",
"path": "ReceiptNoticeModel.item.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ReceiptNoticeModel.item.modifierExtension",
"path": "ReceiptNoticeModel.item.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ReceiptNoticeModel.item.itemreference[x]",
"path": "ReceiptNoticeModel.item.itemreference[x]",
"short": "item reference",
"definition": "item reference",
"min": 1,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.item.itemreference[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference"
},
{
"code": "CodeableConcept"
}
]
},
{
"id": "ReceiptNoticeModel.item.quantity",
"path": "ReceiptNoticeModel.item.quantity",
"short": "quantity",
"definition": "quantity",
"comment": "This is the count of items that have been received. This does not mean a pack quantity. For example if one box containing 20 devices has been received, and the code is for the box, then quantity is 1. If however, the code used to identify the product is the code of the device, then the quantity is 20.",
"min": 1,
"max": "1",
"base": {
"path": "ReceiptNoticeModel.item.quantity",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Quantity"
}
]
},
{
"id": "ReceiptNoticeModel.additionalInfo[x]",
"path": "ReceiptNoticeModel.additionalInfo[x]",
"short": "Additional information about the delivery",
"definition": "Additional information about the delivery - this can be relevant history, any remarks by the patient or professional, etc.",
"min": 0,
"max": "*",
"base": {
"path": "ReceiptNoticeModel.additionalInfo[x]",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference"
},
{
"code": "Annotation"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ReceiptNoticeModel",
"path": "ReceiptNoticeModel",
"short": "A request for supply of one or more healthcare products",
"definition": "This is the logical model for the ReceiptNotice"
},
{
"id": "ReceiptNoticeModel.identifier",
"path": "ReceiptNoticeModel.identifier",
"short": "Shipment identifier",
"definition": "Shipment identifier",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "ReceiptNoticeModel.status",
"path": "ReceiptNoticeModel.status",
"short": "status",
"definition": "status",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "ReceiptNoticeModel.dateTime",
"path": "ReceiptNoticeModel.dateTime",
"short": "date time",
"definition": "date time",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "ReceiptNoticeModel.requestIdentifier",
"path": "ReceiptNoticeModel.requestIdentifier",
"short": "Request identifier",
"definition": "Request identifier",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "ReceiptNoticeModel.supplier",
"path": "ReceiptNoticeModel.supplier",
"short": "Supplier",
"definition": "Supplier",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "ReceiptNoticeModel.supplierLocation",
"path": "ReceiptNoticeModel.supplierLocation",
"short": "Supplier location",
"definition": "Supplier location",
"min": 0,
"max": "1",
"type": [
{
"code": "Location"
}
]
},
{
"id": "ReceiptNoticeModel.receiver",
"path": "ReceiptNoticeModel.receiver",
"short": "Receiver",
"definition": "Receiver",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference"
}
]
},
{
"id": "ReceiptNoticeModel.receiverLocation",
"path": "ReceiptNoticeModel.receiverLocation",
"short": "receiver location",
"definition": "receiver location",
"min": 0,
"max": "1",
"type": [
{
"code": "Location"
}
]
},
{
"id": "ReceiptNoticeModel.item",
"path": "ReceiptNoticeModel.item",
"short": "item",
"definition": "item",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ReceiptNoticeModel.item.itemreference[x]",
"path": "ReceiptNoticeModel.item.itemreference[x]",
"short": "item reference",
"definition": "item reference",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference"
},
{
"code": "CodeableConcept"
}
]
},
{
"id": "ReceiptNoticeModel.item.quantity",
"path": "ReceiptNoticeModel.item.quantity",
"short": "quantity",
"definition": "quantity",
"comment": "This is the count of items that have been received. This does not mean a pack quantity. For example if one box containing 20 devices has been received, and the code is for the box, then quantity is 1. If however, the code used to identify the product is the code of the device, then the quantity is 20.",
"min": 1,
"max": "1",
"type": [
{
"code": "Quantity"
}
]
},
{
"id": "ReceiptNoticeModel.additionalInfo[x]",
"path": "ReceiptNoticeModel.additionalInfo[x]",
"short": "Additional information about the delivery",
"definition": "Additional information about the delivery - this can be relevant history, any remarks by the patient or professional, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference"
},
{
"code": "Annotation"
}
]
}
]
}
}