Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Shareable Medication

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablemedication Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: CRMIShareableMedication
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.76

Enforces the minimum information set for the medication metadata required by HL7 and other organizations that share and publish medications

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Medication C 1..1 CRMIMedicationDefinition Definition of a Medication
Constraints: shr-1
Medication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Medication.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Medication.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Medication.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Medication.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Medication.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Medication.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Medication.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Medication.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Medication.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Medication.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Medication.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Medication.Slices for extension.extension:description This element must be supported. 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
Medication.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for modifierExtension.modifierExtension:artifactStatus This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Medication.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business identifier for this medication
Medication.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Medication.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
Medication.ingredient This element must be supported. 0..* BackboneElement Active or inactive ingredient
Medication.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Medication.ingredient.Slices for item[x] This element must be supported. 1..1 The actual ingredient or content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Medication.ingredient.Slices for item[x].itemCodeableConcept CodeableConcept
Medication.ingredient.Slices for item[x].itemReference Reference(Substance | Medication)
Medication.ingredient.Slices for item[x].item[x]:itemReference This element must be supported. 0..1 Reference(Substance | Medication) The actual ingredient or content
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension Content/Rules for all slices
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication 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 Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()
shr-1 error Medication If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from CRMIMedicationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Medication C 1..1 CRMIMedicationDefinition Definition of a Medication
Constraints: shr-1
Medication.Slices for extension Content/Rules for all slices
Medication.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Medication.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Medication.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Medication.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Medication.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Medication.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Medication.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Medication.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Medication.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Medication.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Medication.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Medication.Slices for extension.extension:description This element must be supported. 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
Medication.Slices for modifierExtension Content/Rules for all slices
Medication.Slices for modifierExtension.modifierExtension:artifactStatus This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error Medication If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Medication C 1..1 CRMIMedicationDefinition Definition of a Medication
Constraints: shr-1
Medication.id This element is included in summaries. 0..1 id Logical id of this artifact
Medication.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Medication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Medication.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Medication.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Medication.contained 0..* Resource Contained, inline Resources
Medication.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Medication.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Medication.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Medication.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Medication.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Medication.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Medication.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Medication.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Medication.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Medication.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Medication.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Medication.Slices for extension.extension:description This element must be supported. 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
Medication.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for modifierExtension.modifierExtension:artifactStatus This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Medication.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business identifier for this medication
Medication.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Medication.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
Medication.manufacturer This element is included in summaries. 0..1 Reference(Organization) Manufacturer of the item
Medication.form 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Medication.amount This element is included in summaries. 0..1 Ratio Amount of drug in package
Medication.ingredient This element must be supported. 0..* BackboneElement Active or inactive ingredient
Medication.ingredient.id 0..1 string Unique id for inter-element referencing
Medication.ingredient.extension 0..* Extension Additional content defined by implementations
Medication.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Medication.ingredient.Slices for item[x] This element must be supported. 1..1 The actual ingredient or content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Medication.ingredient.Slices for item[x].itemCodeableConcept CodeableConcept
Medication.ingredient.Slices for item[x].itemReference Reference(Substance | Medication)
Medication.ingredient.Slices for item[x].item[x]:itemReference This element must be supported. 0..1 Reference(Substance | Medication) The actual ingredient or content
Medication.ingredient.Slices for item[x].item[x]:itemReference.id 0..1 string Unique id for inter-element referencing
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension Content/Rules for all slices
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Medication.ingredient.Slices for item[x].item[x]:itemReference.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Medication.ingredient.Slices for item[x].item[x]:itemReference.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Medication.ingredient.Slices for item[x].item[x]:itemReference.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Medication.ingredient.Slices for item[x].item[x]:itemReference.display This element is included in summaries. 0..1 string Text alternative for the resource
Medication.ingredient.isActive 0..1 boolean Active ingredient indicator
Medication.ingredient.strength 0..1 Ratio Quantity of ingredient present

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.ingredient.​item[x]:itemReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication 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 Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()
shr-1 error Medication If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Medication C 1..1 CRMIMedicationDefinition Definition of a Medication
Constraints: shr-1
Medication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Medication.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Medication.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Medication.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Medication.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Medication.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Medication.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Medication.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Medication.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Medication.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Medication.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Medication.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Medication.Slices for extension.extension:description This element must be supported. 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
Medication.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for modifierExtension.modifierExtension:artifactStatus This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Medication.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business identifier for this medication
Medication.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Medication.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
Medication.ingredient This element must be supported. 0..* BackboneElement Active or inactive ingredient
Medication.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Medication.ingredient.Slices for item[x] This element must be supported. 1..1 The actual ingredient or content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Medication.ingredient.Slices for item[x].itemCodeableConcept CodeableConcept
Medication.ingredient.Slices for item[x].itemReference Reference(Substance | Medication)
Medication.ingredient.Slices for item[x].item[x]:itemReference This element must be supported. 0..1 Reference(Substance | Medication) The actual ingredient or content
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension Content/Rules for all slices
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication 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 Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()
shr-1 error Medication If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Differential View

This structure is derived from CRMIMedicationDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Medication C 1..1 CRMIMedicationDefinition Definition of a Medication
Constraints: shr-1
Medication.Slices for extension Content/Rules for all slices
Medication.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Medication.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Medication.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Medication.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Medication.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Medication.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Medication.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Medication.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Medication.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Medication.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Medication.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Medication.Slices for extension.extension:description This element must be supported. 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
Medication.Slices for modifierExtension Content/Rules for all slices
Medication.Slices for modifierExtension.modifierExtension:artifactStatus This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error Medication If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Medication C 1..1 CRMIMedicationDefinition Definition of a Medication
Constraints: shr-1
Medication.id This element is included in summaries. 0..1 id Logical id of this artifact
Medication.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Medication.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Medication.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Medication.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Medication.contained 0..* Resource Contained, inline Resources
Medication.Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Medication.Slices for extension.extension:artifactComment This element must be supported. 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Medication.Slices for extension.extension:url This element must be supported. 1..1 uri Canonical identifier for this artifact, represented as a URI (globally unique)
URL: http://hl7.org/fhir/StructureDefinition/artifact-url
Medication.Slices for extension.extension:version This element must be supported. 1..1 string Business version of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-version
Medication.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Medication.Slices for extension.extension:versionPolicy This element must be supported. 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
Medication.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Medication.Slices for extension.extension:name This element must be supported. 0..1 string Name for this artifact (computer friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-name
Medication.Slices for extension.extension:title This element must be supported. 1..1 string Name for this artifact (human friendly)
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
Medication.Slices for extension.extension:experimental This element must be supported. 0..1 boolean For testing purposes, not real usage
URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental
Medication.Slices for extension.extension:publisher This element must be supported. 0..1 string Name of the publisher/steward (organization or individual)
URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher
Medication.Slices for extension.extension:description This element must be supported. 0..1 markdown Natural language description of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
Medication.Slices for modifierExtension This element is a modifier element. 1..* Extension Extension
Slice: Unordered, Open by value:url
Medication.Slices for modifierExtension.modifierExtension:artifactStatus This element is a modifier element. This element must be supported. 1..1 code draft | active | retired | unknown
URL: http://hl7.org/fhir/StructureDefinition/artifact-status
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Medication.identifier This element must be supported. This element is included in summaries. 0..* Identifier Business identifier for this medication
Medication.code This element must be supported. This element is included in summaries. 0..1 CodeableConcept Codes that identify this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
Medication.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | inactive | entered-in-error
Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use.
Medication.manufacturer This element is included in summaries. 0..1 Reference(Organization) Manufacturer of the item
Medication.form 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.
Medication.amount This element is included in summaries. 0..1 Ratio Amount of drug in package
Medication.ingredient This element must be supported. 0..* BackboneElement Active or inactive ingredient
Medication.ingredient.id 0..1 string Unique id for inter-element referencing
Medication.ingredient.extension 0..* Extension Additional content defined by implementations
Medication.ingredient.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Medication.ingredient.Slices for item[x] This element must be supported. 1..1 The actual ingredient or content
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Medication.ingredient.Slices for item[x].itemCodeableConcept CodeableConcept
Medication.ingredient.Slices for item[x].itemReference Reference(Substance | Medication)
Medication.ingredient.Slices for item[x].item[x]:itemReference This element must be supported. 0..1 Reference(Substance | Medication) The actual ingredient or content
Medication.ingredient.Slices for item[x].item[x]:itemReference.id 0..1 string Unique id for inter-element referencing
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension Content/Rules for all slices
Medication.ingredient.Slices for item[x].item[x]:itemReference.Slices for extension.extension:nonCanonicalReference This element must be supported. 0..1 uri The artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-uriReference
Medication.ingredient.Slices for item[x].item[x]:itemReference.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Medication.ingredient.Slices for item[x].item[x]:itemReference.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Medication.ingredient.Slices for item[x].item[x]:itemReference.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Medication.ingredient.Slices for item[x].item[x]:itemReference.display This element is included in summaries. 0..1 string Text alternative for the resource
Medication.ingredient.isActive 0..1 boolean Active ingredient indicator
Medication.ingredient.strength 0..1 Ratio Quantity of ingredient present

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Medication.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Medication.code Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.
Medication.status Base required Medication status codes 📍4.0.1 FHIR Std.
Medication.form Base example SNOMED CT Form Codes 📍4.0.1 FHIR Std.
Medication.ingredient.​item[x]:itemReference.​type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Medication If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Medication 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Medication 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 Medication If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Medication 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()
shr-1 error Medication If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

 

Other representations of profile: CSV, Excel, Schematron