Profile: Composition (MedicationDispense)

Simplifier project page: CompositionMedicationDispense

Derived from: Composition (R4)

Canonical_URLProfile_StatusProfile_VersionFHIR_Version
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Composition-medDisactive4.0.14.0.1

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
categoryΣ0..*CodeableConcept
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterΣ I0..1Reference(Encounter)
dateS Σ1..1dateTime
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
titleS Σ1..1stringFixed Value
confidentialityΣ0..1codeBinding
mode1..1codeBinding
time0..1dateTime
partyI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(Composition)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
detailΣ I0..*Reference(Resource)
titleS1..1stringFixed Value
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Hybrid View

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
categoryΣ0..*CodeableConcept
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterΣ I0..1Reference(Encounter)
dateS Σ1..1dateTime
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
titleS Σ1..1stringFixed Value
confidentialityΣ0..1codeBinding
mode1..1codeBinding
time0..1dateTime
partyI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(Composition)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
detailΣ I0..*Reference(Resource)
titleS1..1stringFixed Value
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Snapshot View

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uri
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
statusS Σ ?!1..1codeBinding
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
categoryΣ0..*CodeableConcept
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterΣ I0..1Reference(Encounter)
dateS Σ1..1dateTime
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
titleS Σ1..1stringFixed Value
confidentialityΣ0..1codeBinding
mode1..1codeBinding
time0..1dateTime
partyI0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
code1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(Composition)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
detailΣ I0..*Reference(Resource)
titleS1..1stringFixed Value
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayS Σ1..1stringFixed Value
userSelectedΣ0..1boolean
textΣ0..1string
authorI0..*Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)
focusI0..1Reference(Resource)
textI0..1Narrative
mode0..1codeBinding
orderedBy0..1CodeableConceptBinding
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)

Table View

Composition..
Composition.id..
Composition.meta1..
Composition.meta.profile1..
Composition.identifier1..
Composition.identifier.system1..
Composition.identifier.value1..
Composition.status..
Composition.type..
Composition.type.coding1..1
Composition.type.coding.system1..
Composition.type.coding.code1..
Composition.type.coding.display1..
Composition.subjectReference(Patient (Submission) | Patient)1..
Composition.subject.reference1..
Composition.date..
Composition.authorReference(PractitionerRole (Submission) | PractitionerRole)..
Composition.author.reference1..
Composition.title..
Composition.custodianReference(Organization (Submission) | Organization)1..
Composition.custodian.reference1..
Composition.section1..
Composition.section.title1..
Composition.section.code1..
Composition.section.code.coding1..1
Composition.section.code.coding.system1..
Composition.section.code.coding.code1..
Composition.section.code.coding.display1..
Composition.section.entryReference(MedicationDispense | MedicationDispense (Submission))1..
Composition.section.entry.reference1..


JSON View

{
    "resourceType": "StructureDefinition",
    "text": {
        "status": "empty",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Composition-medDis",
    "version": "4.0.1",
    "name": "CompositionMedicationDispense",
    "title": "CompositionMedicationDispense",
    "status": "active",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Composition",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Composition",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Composition.id",
                "path": "Composition.id",
                "mustSupport": true
            },
            {
                "id": "Composition.meta",
                "path": "Composition.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.meta.profile",
                "path": "Composition.meta.profile",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.identifier",
                "path": "Composition.identifier",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.identifier.system",
                "path": "Composition.identifier.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.identifier.value",
                "path": "Composition.identifier.value",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.status",
                "path": "Composition.status",
                "mustSupport": true
            },
            {
                "id": "Composition.type",
                "path": "Composition.type",
                "mustSupport": true
            },
            {
                "id": "Composition.type.coding",
                "path": "Composition.type.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Composition.type.coding.system",
                "path": "Composition.type.coding.system",
                "min": 1,
                "fixedUri": "http://loinc.org",
                "mustSupport": true
            },
            {
                "id": "Composition.type.coding.code",
                "path": "Composition.type.coding.code",
                "min": 1,
                "fixedCode": "29550-1",
                "mustSupport": true
            },
            {
                "id": "Composition.type.coding.display",
                "path": "Composition.type.coding.display",
                "min": 1,
                "fixedString": "Medication dispensed",
                "mustSupport": true
            },
            {
                "id": "Composition.subject",
                "path": "Composition.subject",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Patient-submission",
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Composition.subject.reference",
                "path": "Composition.subject.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.date",
                "path": "Composition.date",
                "mustSupport": true
            },
            {
                "id": "Composition.author",
                "path": "Composition.author",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-PractitionerRole-submission",
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-PractitionerRole"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Composition.author.reference",
                "path": "Composition.author.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.title",
                "path": "Composition.title",
                "fixedString": "Medication dispensed",
                "mustSupport": true
            },
            {
                "id": "Composition.custodian",
                "path": "Composition.custodian",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Organization-submission",
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Organization"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Composition.custodian.reference",
                "path": "Composition.custodian.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.section",
                "path": "Composition.section",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.section.title",
                "path": "Composition.section.title",
                "min": 1,
                "fixedString": "Medication dispensed",
                "mustSupport": true
            },
            {
                "id": "Composition.section.code",
                "path": "Composition.section.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Composition.section.code.coding",
                "path": "Composition.section.code.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Composition.section.code.coding.system",
                "path": "Composition.section.code.coding.system",
                "min": 1,
                "fixedUri": "http://loinc.org",
                "mustSupport": true
            },
            {
                "id": "Composition.section.code.coding.code",
                "path": "Composition.section.code.coding.code",
                "min": 1,
                "fixedCode": "29550-1",
                "mustSupport": true
            },
            {
                "id": "Composition.section.code.coding.display",
                "path": "Composition.section.code.coding.display",
                "min": 1,
                "fixedString": "Medication dispensed",
                "mustSupport": true
            },
            {
                "id": "Composition.section.entry",
                "path": "Composition.section.entry",
                "min": 1,
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-MedicationDispense",
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-MedicationDispense-submission"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Composition.section.entry.reference",
                "path": "Composition.section.entry.reference",
                "min": 1,
                "mustSupport": true
            }
        ]
    }
}

Usage

The Composition resource is used to represent the MedicationDispense data set as a document.

Notes

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Composition-medDis|4.0.1

.identifier

  • the Composition business identifier
  • identifier.system SHALL be a URL provided by Ontario Health during onboarding process

.status

  • for the new MedicationDispense SHOULD be set to final
  • when invalidating an existing record SHOULD be set to entered-in-error
  • for updating an existing record SHOULD be set to amended

.type

  • .coding to type of document to consumer systems, where
  • .system SHALL be fixed to "http://loinc.org"
  • .code SHALL be fixed to "29550-1"
  • .display SHALL be fixed to "Medication dispensed"

.subject SHALL be populated with a reference to a Patient resource included in a Bundle.entry

.date

  • the datetime when the author created or amended the medication record
  • format: YYYY, YYYY-MM, YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+zz:zz

.author

  • SHOULD contain a reference to the PractitionerRole that specifies the author of the document

.title

  • SHALL be fixed to "Medication dispensed"

.custodian

  • SHALL identify the "Health Information Custodian" (as that term is defined in PHIPA) that provides the Medication Dispense to Ontario Health as a Prescribed Organization for the purposes of the EHR.
  • SHALL be populated with a reference to an Organization resource included in a Bundle.entry

.section

  • all resources referenced in the composition SHALL be contained within the bundle