Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use
Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use
This page is part of the Electronic Medicinal Product Information (ePI) FHIR Implementation Guide (v1.0.0: STU1) based on FHIR v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/AdministrableProductDefinition-uv-epi | Version: 1.0.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AdministrableProductDefinitionUvEpi | ||
AdministrableProductDefinition (ePI)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AdministrableProductDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AdministrableProductDefinition | 0..* | AdministrableProductDefinition | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |
  identifier | 1..* | Identifier | An identifier for the administrable product | |
  system | 1..1 | uri | The namespace for the identifier value | |
 value | 1..1 | string | The value that is unique | |
| status | 1..1 | code | draft | active | retired |unknown | |
 formOf | 0..* | Reference(MedicinalProductDefinition (ePI)) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product | |
| administrableDoseForm | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Pharmaceutical Dose Form (example) | |
| unitOfPresentation | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Units of Presentation (example) | |
| producedFrom | 0..* | Reference(ManufacturedItemDefinition (ePI)) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | |
 Slices for property | 0..* | BackboneElement | Characteristics e.g. a product's onset of action Slice: Unordered, Open by value:type | |
  property:color | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
  type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
   coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: color | |
  value[x] | 0..1 | CodeableConcept | A value for the characteristic Binding: Color of the product (example) | |
| property:flavor | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: flavor | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic Binding: Flavor of the product (example) | |
| property:score | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: scoring | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic | |
| property:shape | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: shape | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic Binding: Shape of the product (example) | |
| property:surfaceform | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: surfaceform | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic | |
| property:size | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: size | |
| value[x] | 0..1 | Quantity | A value for the characteristic | |
| property:image | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
 value[x] | 0..1 | Attachment | A value for the characteristic | |
| data | 0..1 | base64Binary | base64 version of the product image | |
 property:imprint | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imprintcd | |
| Slices for value[x] | 0..1 | A value for the characteristic Slice: Unordered, Open by type:$this | ||
 valueCodeableConcept | CodeableConcept | |||
| valueAttachment | Attachment | |||
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | A value for the characteristic | |
 coding | 0..0 | |||
| text | 1..1 | string | Plain text representation of the concept | |
| routeOfAdministration | ||||
| code | 1..1 | CodeableConcept | Coded expression for the route Binding: Route Of Administration (example) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AdministrableProductDefinition.administrableDoseForm | example | VsAdministrableDoseForm |
| AdministrableProductDefinition.unitOfPresentation | example | VsUnitofPresentation |
| AdministrableProductDefinition.property:color.value[x] | example | VsPropertyColor |
| AdministrableProductDefinition.property:flavor.value[x] | example | VsPropertyFlavor |
| AdministrableProductDefinition.property:shape.value[x] | example | VsPropertyShape |
| AdministrableProductDefinition.routeOfAdministration.code | example | VsRouteOfAdministration |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AdministrableProductDefinition | C | 0..* | AdministrableProductDefinition | A medicinal product in the final form, suitable for administration - after any mixing of multiple components |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..* | Identifier | An identifier for the administrable product |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| formOf | ΣC | 0..* | Reference(MedicinalProductDefinition (ePI)) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product |
| administrableDoseForm | Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Pharmaceutical Dose Form (example) |
| unitOfPresentation | Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Units of Presentation (example) |
| producedFrom | Σ | 0..* | Reference(ManufacturedItemDefinition (ePI)) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
| Slices for property | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action Slice: Unordered, Open by value:type |
| property:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. |
| property:color | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: color | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Color of the product (example) |
| property:flavor | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: flavor | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Flavor of the product (example) |
| property:score | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: scoring | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| property:shape | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: shape | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Shape of the product (example) |
| property:surfaceform | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: surfaceform | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| property:size | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: size | |
| value[x] | Σ | 0..1 | Quantity | A value for the characteristic |
| property:image | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| value[x] | Σ | 0..1 | Attachment | A value for the characteristic |
| data | C | 0..1 | base64Binary | base64 version of the product image |
| property:imprint | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imprintcd | |
| Slices for value[x] | Σ | 0..1 | A value for the characteristic Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | CodeableConcept | |||
| valueAttachment | Attachment | |||
| value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| routeOfAdministration | Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Coded expression for the route Binding: Route Of Administration (example) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AdministrableProductDefinition.identifier.use | required | IdentifierUse |
| AdministrableProductDefinition.status | required | PublicationStatus |
| AdministrableProductDefinition.administrableDoseForm | example | VsAdministrableDoseForm |
| AdministrableProductDefinition.unitOfPresentation | example | VsUnitofPresentation |
| AdministrableProductDefinition.property.type | example | ProductCharacteristic |
| AdministrableProductDefinition.property:color.type | example | Pattern: color |
| AdministrableProductDefinition.property:color.value[x] | example | VsPropertyColor |
| AdministrableProductDefinition.property:flavor.type | example | Pattern: flavor |
| AdministrableProductDefinition.property:flavor.value[x] | example | VsPropertyFlavor |
| AdministrableProductDefinition.property:score.type | example | Pattern: scoring |
| AdministrableProductDefinition.property:shape.type | example | Pattern: shape |
| AdministrableProductDefinition.property:shape.value[x] | example | VsPropertyShape |
| AdministrableProductDefinition.property:surfaceform.type | example | Pattern: surfaceform |
| AdministrableProductDefinition.property:size.type | example | Pattern: size |
| AdministrableProductDefinition.property:image.type | example | Pattern: image |
| AdministrableProductDefinition.property:imprint.type | example | Pattern: imprintcd |
| AdministrableProductDefinition.routeOfAdministration.code | example | VsRouteOfAdministration |
| Id | Grade | Path(s) | Details | Requirements |
| apd-1 | error | AdministrableProductDefinition | RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) : AdministrableProductDefinition.formOf.resolve().route.empty() | |
| dom-2 | error | AdministrableProductDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AdministrableProductDefinition | 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AdministrableProductDefinition | 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 | AdministrableProductDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AdministrableProductDefinition | 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 |
|---|---|---|---|---|
| AdministrableProductDefinition | C | 0..* | AdministrableProductDefinition | A medicinal product in the final form, suitable for administration - after any mixing of multiple components |
| 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: AllLanguages (required): IETF language tag for 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 | Σ | 1..* | Identifier | An identifier for the administrable product |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| formOf | ΣC | 0..* | Reference(MedicinalProductDefinition (ePI)) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product |
| administrableDoseForm | Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Pharmaceutical Dose Form (example) |
| unitOfPresentation | Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Units of Presentation (example) |
| producedFrom | Σ | 0..* | Reference(ManufacturedItemDefinition (ePI)) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
| ingredient | Σ | 0..* | CodeableConcept | The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set. |
| device | Σ | 0..1 | Reference(DeviceDefinition) | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product |
| description | 0..1 | markdown | A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed | |
| Slices for property | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action Slice: Unordered, Open by value:type |
| property:All Slices | Content/Rules for all slices | |||
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. |
 value[x] | Σ | 0..1 | A value for the characteristic | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueDate | date | |||
| valueBoolean | boolean | |||
| valueMarkdown | markdown | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Binary) | |||
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:color | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: color | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Color of the product (example) |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:flavor | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: flavor | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Flavor of the product (example) |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:score | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: scoring | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:shape | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: shape | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Shape of the product (example) |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:surfaceform | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: surfaceform | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:size | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: size | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | Quantity | A value for the characteristic |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:image | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | Attachment | A value for the characteristic |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language. Example General: en-AU |
| data | C | 0..1 | base64Binary | base64 version of the product image |
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | integer64 | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| height | TU | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | TU | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | TU | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | TU | 0..1 | decimal | Length in seconds (audio / video) |
| pages | TU | 0..1 | positiveInt | Number of printed pages |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:imprint | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imprintcd | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| Slices for value[x] | Σ | 0..1 | A value for the characteristic Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | CodeableConcept | |||
| valueAttachment | Attachment | |||
| value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| routeOfAdministration | Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body |
| 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 | Σ | 1..1 | CodeableConcept | Coded expression for the route Binding: Route Of Administration (example) |
| firstDose | Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product |
| maxSingleDose | Σ | 0..1 | Quantity | The maximum single dose that can be administered |
| maxDosePerDay | Σ | 0..1 | Quantity | The maximum dose quantity to be administered in any one 24-h period |
| maxDosePerTreatmentPeriod | Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered |
| maxTreatmentPeriod | Σ | 0..1 | Duration | The maximum treatment period during which the product can be administered |
| targetSpecies | Σ | 0..* | BackboneElement | A species for which this route applies |
| 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 | Σ | 1..1 | CodeableConcept | Coded expression for the species Binding: TargetSpecies (example): A tissue type of an animal. |
| withdrawalPeriod | Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate |
| 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 |
| tissue | Σ | 1..1 | CodeableConcept | The type of tissue for which the withdrawal period applies, e.g. meat, milk Binding: AnimalTissueType (example): A tissue type of an animal. |
| value | Σ | 1..1 | Quantity | A value for the time |
| supportingInformation | Σ | 0..1 | string | Extra information about the withdrawal period |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AdministrableProductDefinition.language | required | AllLanguages |
| AdministrableProductDefinition.identifier.use | required | IdentifierUse |
| AdministrableProductDefinition.identifier.type | extensible | IdentifierTypeCodes |
| AdministrableProductDefinition.status | required | PublicationStatus |
| AdministrableProductDefinition.administrableDoseForm | example | VsAdministrableDoseForm |
| AdministrableProductDefinition.unitOfPresentation | example | VsUnitofPresentation |
| AdministrableProductDefinition.ingredient | example | SNOMEDCTSubstanceCodes |
| AdministrableProductDefinition.property.type | example | ProductCharacteristic |
| AdministrableProductDefinition.property.status | required | PublicationStatus |
| AdministrableProductDefinition.property:color.type | example | Pattern: color |
| AdministrableProductDefinition.property:color.value[x] | example | VsPropertyColor |
| AdministrableProductDefinition.property:color.status | required | PublicationStatus |
| AdministrableProductDefinition.property:flavor.type | example | Pattern: flavor |
| AdministrableProductDefinition.property:flavor.value[x] | example | VsPropertyFlavor |
| AdministrableProductDefinition.property:flavor.status | required | PublicationStatus |
| AdministrableProductDefinition.property:score.type | example | Pattern: scoring |
| AdministrableProductDefinition.property:score.status | required | PublicationStatus |
| AdministrableProductDefinition.property:shape.type | example | Pattern: shape |
| AdministrableProductDefinition.property:shape.value[x] | example | VsPropertyShape |
| AdministrableProductDefinition.property:shape.status | required | PublicationStatus |
| AdministrableProductDefinition.property:surfaceform.type | example | Pattern: surfaceform |
| AdministrableProductDefinition.property:surfaceform.status | required | PublicationStatus |
| AdministrableProductDefinition.property:size.type | example | Pattern: size |
| AdministrableProductDefinition.property:size.status | required | PublicationStatus |
| AdministrableProductDefinition.property:image.type | example | Pattern: image |
| AdministrableProductDefinition.property:image.value[x].contentType | required | MimeTypes (a valid code from urn:ietf:bcp:13) |
| AdministrableProductDefinition.property:image.value[x].language | required | AllLanguages |
| AdministrableProductDefinition.property:image.status | required | PublicationStatus |
| AdministrableProductDefinition.property:imprint.type | example | Pattern: imprintcd |
| AdministrableProductDefinition.property:imprint.status | required | PublicationStatus |
| AdministrableProductDefinition.routeOfAdministration.code | example | VsRouteOfAdministration |
| AdministrableProductDefinition.routeOfAdministration.targetSpecies.code | example | TargetSpecies |
| AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue | example | AnimalTissueType |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AdministrableProductDefinition
Summary
Mandatory: 3 elements (1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Differential View
This structure is derived from AdministrableProductDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AdministrableProductDefinition | 0..* | AdministrableProductDefinition | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |
| identifier | 1..* | Identifier | An identifier for the administrable product | |
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| status | 1..1 | code | draft | active | retired |unknown | |
| formOf | 0..* | Reference(MedicinalProductDefinition (ePI)) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product | |
| administrableDoseForm | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Pharmaceutical Dose Form (example) | |
| unitOfPresentation | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Units of Presentation (example) | |
| producedFrom | 0..* | Reference(ManufacturedItemDefinition (ePI)) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form | |
| Slices for property | 0..* | BackboneElement | Characteristics e.g. a product's onset of action Slice: Unordered, Open by value:type | |
| property:color | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: color | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic Binding: Color of the product (example) | |
| property:flavor | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: flavor | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic Binding: Flavor of the product (example) | |
| property:score | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: scoring | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic | |
| property:shape | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: shape | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic Binding: Shape of the product (example) | |
| property:surfaceform | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: surfaceform | |
| value[x] | 0..1 | CodeableConcept | A value for the characteristic | |
| property:size | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: size | |
| value[x] | 0..1 | Quantity | A value for the characteristic | |
| property:image | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| value[x] | 0..1 | Attachment | A value for the characteristic | |
| data | 0..1 | base64Binary | base64 version of the product image | |
| property:imprint | 0..* | BackboneElement | Characteristics e.g. a product's onset of action | |
| type | 1..1 | CodeableConcept | A code expressing the type of characteristic Required Pattern: At least the following | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imprintcd | |
| Slices for value[x] | 0..1 | A value for the characteristic Slice: Unordered, Open by type:$this | ||
| valueCodeableConcept | CodeableConcept | |||
| valueAttachment | Attachment | |||
| value[x]:valueCodeableConcept | 0..1 | CodeableConcept | A value for the characteristic | |
| coding | 0..0 | |||
| text | 1..1 | string | Plain text representation of the concept | |
| routeOfAdministration | ||||
| code | 1..1 | CodeableConcept | Coded expression for the route Binding: Route Of Administration (example) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AdministrableProductDefinition.administrableDoseForm | example | VsAdministrableDoseForm |
| AdministrableProductDefinition.unitOfPresentation | example | VsUnitofPresentation |
| AdministrableProductDefinition.property:color.value[x] | example | VsPropertyColor |
| AdministrableProductDefinition.property:flavor.value[x] | example | VsPropertyFlavor |
| AdministrableProductDefinition.property:shape.value[x] | example | VsPropertyShape |
| AdministrableProductDefinition.routeOfAdministration.code | example | VsRouteOfAdministration |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AdministrableProductDefinition | C | 0..* | AdministrableProductDefinition | A medicinal product in the final form, suitable for administration - after any mixing of multiple components |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..* | Identifier | An identifier for the administrable product |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| formOf | ΣC | 0..* | Reference(MedicinalProductDefinition (ePI)) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product |
| administrableDoseForm | Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Pharmaceutical Dose Form (example) |
| unitOfPresentation | Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Units of Presentation (example) |
| producedFrom | Σ | 0..* | Reference(ManufacturedItemDefinition (ePI)) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
| Slices for property | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action Slice: Unordered, Open by value:type |
| property:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. |
| property:color | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: color | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Color of the product (example) |
| property:flavor | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: flavor | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Flavor of the product (example) |
| property:score | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: scoring | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| property:shape | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: shape | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Shape of the product (example) |
| property:surfaceform | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: surfaceform | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| property:size | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: size | |
| value[x] | Σ | 0..1 | Quantity | A value for the characteristic |
| property:image | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| value[x] | Σ | 0..1 | Attachment | A value for the characteristic |
| data | C | 0..1 | base64Binary | base64 version of the product image |
| property:imprint | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imprintcd | |
| Slices for value[x] | Σ | 0..1 | A value for the characteristic Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | CodeableConcept | |||
| valueAttachment | Attachment | |||
| value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| routeOfAdministration | Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code | Σ | 1..1 | CodeableConcept | Coded expression for the route Binding: Route Of Administration (example) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AdministrableProductDefinition.identifier.use | required | IdentifierUse |
| AdministrableProductDefinition.status | required | PublicationStatus |
| AdministrableProductDefinition.administrableDoseForm | example | VsAdministrableDoseForm |
| AdministrableProductDefinition.unitOfPresentation | example | VsUnitofPresentation |
| AdministrableProductDefinition.property.type | example | ProductCharacteristic |
| AdministrableProductDefinition.property:color.type | example | Pattern: color |
| AdministrableProductDefinition.property:color.value[x] | example | VsPropertyColor |
| AdministrableProductDefinition.property:flavor.type | example | Pattern: flavor |
| AdministrableProductDefinition.property:flavor.value[x] | example | VsPropertyFlavor |
| AdministrableProductDefinition.property:score.type | example | Pattern: scoring |
| AdministrableProductDefinition.property:shape.type | example | Pattern: shape |
| AdministrableProductDefinition.property:shape.value[x] | example | VsPropertyShape |
| AdministrableProductDefinition.property:surfaceform.type | example | Pattern: surfaceform |
| AdministrableProductDefinition.property:size.type | example | Pattern: size |
| AdministrableProductDefinition.property:image.type | example | Pattern: image |
| AdministrableProductDefinition.property:imprint.type | example | Pattern: imprintcd |
| AdministrableProductDefinition.routeOfAdministration.code | example | VsRouteOfAdministration |
| Id | Grade | Path(s) | Details | Requirements |
| apd-1 | error | AdministrableProductDefinition | RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) : AdministrableProductDefinition.formOf.resolve().route.empty() | |
| dom-2 | error | AdministrableProductDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | AdministrableProductDefinition | 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 in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | AdministrableProductDefinition | 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 | AdministrableProductDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | AdministrableProductDefinition | 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 |
|---|---|---|---|---|
| AdministrableProductDefinition | C | 0..* | AdministrableProductDefinition | A medicinal product in the final form, suitable for administration - after any mixing of multiple components |
| 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: AllLanguages (required): IETF language tag for 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 | Σ | 1..* | Identifier | An identifier for the administrable product |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| status | ?!Σ | 1..1 | code | draft | active | retired |unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| formOf | ΣC | 0..* | Reference(MedicinalProductDefinition (ePI)) | References a product from which one or more of the constituent parts of that product can be prepared and used as described by this administrable product |
| administrableDoseForm | Σ | 0..1 | CodeableConcept | The dose form of the final product after necessary reconstitution or processing Binding: Administrable Pharmaceutical Dose Form (example) |
| unitOfPresentation | Σ | 0..1 | CodeableConcept | The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Units of Presentation (example) |
| producedFrom | Σ | 0..* | Reference(ManufacturedItemDefinition (ePI)) | Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form |
| ingredient | Σ | 0..* | CodeableConcept | The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource Binding: SNOMEDCTSubstanceCodes (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set. |
| device | Σ | 0..1 | Reference(DeviceDefinition) | A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product |
| description | 0..1 | markdown | A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed | |
| Slices for property | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action Slice: Unordered, Open by value:type |
| property:All Slices | Content/Rules for all slices | |||
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. |
| value[x] | Σ | 0..1 | A value for the characteristic | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueDate | date | |||
| valueBoolean | boolean | |||
| valueMarkdown | markdown | |||
| valueAttachment | Attachment | |||
| valueReference | Reference(Binary) | |||
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:color | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: color | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Color of the product (example) |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:flavor | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: flavor | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Flavor of the product (example) |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:score | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: scoring | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:shape | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: shape | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic Binding: Shape of the product (example) |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:surfaceform | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/uv/emedicinal-product-info/CodeSystem/epi-ig | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: surfaceform | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:size | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: size | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | Quantity | A value for the characteristic |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:image | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| value[x] | Σ | 0..1 | Attachment | A value for the characteristic |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| contentType | ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png |
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language. Example General: en-AU |
| data | C | 0..1 | base64Binary | base64 version of the product image |
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
| size | Σ | 0..1 | integer64 | Number of bytes of content (if url provided) |
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) |
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo |
| creation | Σ | 0..1 | dateTime | Date attachment was first created |
| height | TU | 0..1 | positiveInt | Height of the image in pixels (photo/video) |
| width | TU | 0..1 | positiveInt | Width of the image in pixels (photo/video) |
| frames | TU | 0..1 | positiveInt | Number of frames if > 1 (photo) |
| duration | TU | 0..1 | decimal | Length in seconds (audio / video) |
| pages | TU | 0..1 | positiveInt | Number of printed pages |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| property:imprint | Σ | 0..* | BackboneElement | Characteristics e.g. a product's onset of action |
| 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 |
| type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. Required Pattern: At least the following |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/medicationknowledge-characteristic | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: imprintcd | |
| display | 0..1 | string | Representation defined by the system | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| Slices for value[x] | Σ | 0..1 | A value for the characteristic Slice: Unordered, Open by type:$this | |
| valueCodeableConcept | CodeableConcept | |||
| valueAttachment | Attachment | |||
| value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | A value for the characteristic |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| text | Σ | 1..1 | string | Plain text representation of the concept |
| status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| routeOfAdministration | Σ | 1..* | BackboneElement | The path by which the product is taken into or makes contact with the body |
| 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 | Σ | 1..1 | CodeableConcept | Coded expression for the route Binding: Route Of Administration (example) |
| firstDose | Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product |
| maxSingleDose | Σ | 0..1 | Quantity | The maximum single dose that can be administered |
| maxDosePerDay | Σ | 0..1 | Quantity | The maximum dose quantity to be administered in any one 24-h period |
| maxDosePerTreatmentPeriod | Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered |
| maxTreatmentPeriod | Σ | 0..1 | Duration | The maximum treatment period during which the product can be administered |
| targetSpecies | Σ | 0..* | BackboneElement | A species for which this route applies |
| 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 | Σ | 1..1 | CodeableConcept | Coded expression for the species Binding: TargetSpecies (example): A tissue type of an animal. |
| withdrawalPeriod | Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate |
| 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 |
| tissue | Σ | 1..1 | CodeableConcept | The type of tissue for which the withdrawal period applies, e.g. meat, milk Binding: AnimalTissueType (example): A tissue type of an animal. |
| value | Σ | 1..1 | Quantity | A value for the time |
| supportingInformation | Σ | 0..1 | string | Extra information about the withdrawal period |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| AdministrableProductDefinition.language | required | AllLanguages |
| AdministrableProductDefinition.identifier.use | required | IdentifierUse |
| AdministrableProductDefinition.identifier.type | extensible | IdentifierTypeCodes |
| AdministrableProductDefinition.status | required | PublicationStatus |
| AdministrableProductDefinition.administrableDoseForm | example | VsAdministrableDoseForm |
| AdministrableProductDefinition.unitOfPresentation | example | VsUnitofPresentation |
| AdministrableProductDefinition.ingredient | example | SNOMEDCTSubstanceCodes |
| AdministrableProductDefinition.property.type | example | ProductCharacteristic |
| AdministrableProductDefinition.property.status | required | PublicationStatus |
| AdministrableProductDefinition.property:color.type | example | Pattern: color |
| AdministrableProductDefinition.property:color.value[x] | example | VsPropertyColor |
| AdministrableProductDefinition.property:color.status | required | PublicationStatus |
| AdministrableProductDefinition.property:flavor.type | example | Pattern: flavor |
| AdministrableProductDefinition.property:flavor.value[x] | example | VsPropertyFlavor |
| AdministrableProductDefinition.property:flavor.status | required | PublicationStatus |
| AdministrableProductDefinition.property:score.type | example | Pattern: scoring |
| AdministrableProductDefinition.property:score.status | required | PublicationStatus |
| AdministrableProductDefinition.property:shape.type | example | Pattern: shape |
| AdministrableProductDefinition.property:shape.value[x] | example | VsPropertyShape |
| AdministrableProductDefinition.property:shape.status | required | PublicationStatus |
| AdministrableProductDefinition.property:surfaceform.type | example | Pattern: surfaceform |
| AdministrableProductDefinition.property:surfaceform.status | required | PublicationStatus |
| AdministrableProductDefinition.property:size.type | example | Pattern: size |
| AdministrableProductDefinition.property:size.status | required | PublicationStatus |
| AdministrableProductDefinition.property:image.type | example | Pattern: image |
| AdministrableProductDefinition.property:image.value[x].contentType | required | MimeTypes (a valid code from urn:ietf:bcp:13) |
| AdministrableProductDefinition.property:image.value[x].language | required | AllLanguages |
| AdministrableProductDefinition.property:image.status | required | PublicationStatus |
| AdministrableProductDefinition.property:imprint.type | example | Pattern: imprintcd |
| AdministrableProductDefinition.property:imprint.status | required | PublicationStatus |
| AdministrableProductDefinition.routeOfAdministration.code | example | VsRouteOfAdministration |
| AdministrableProductDefinition.routeOfAdministration.targetSpecies.code | example | TargetSpecies |
| AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue | example | AnimalTissueType |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AdministrableProductDefinition
Summary
Mandatory: 3 elements (1 nested mandatory element)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International - Biomedical Research & Regulation Work Group. Package hl7.fhir.uv.emedicinal-product-info#1.0.0 based on FHIR 5.0.0. Generated 2023-07-26
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change