Important: This is a draft IG for trial use. Click here to give feedback.

HdBe-MedicationAgreement

ProfileDescriptionStatusURL
HdBe-MedicationAgreement

A medication agreement is a prescriber’s proposal for a patient to use medication. An agreement to discontinue the use of medication is also a medication agreement.

drafthttps://fhir.healthdata.be/StructureDefinition/HdBe-MedicationAgreement

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueDurationDuration
startΣ I0..1dateTime
endΣ I0..1dateTime
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueDurationDuration
identifier0..*Identifier
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConcept
intentΣ ?!1..1codeBinding
medicationAgreementCode1..1CodeableConceptPattern
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
reportedBooleanboolean
reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
medicationCodeableConceptCodeableConcept
medicationReferenceΣ0..1Reference(Medication | HdBe-PharmaceuticalProduct)
subjectΣ I1..1Reference(Group | HdBe-Patient)
encounterI0..1Reference(Encounter)
supportingInformationI0..*Reference(Resource)
authoredOnΣ0..1dateTime
requesterΣ I0..1pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole)
performerI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)
performerTypeΣ0..1CodeableConcept
recorderI0..1Reference(Practitioner | PractitionerRole)
reasonCode0..1CodeableConceptBinding
reasonReferenceI0..1Reference(Condition | Observation | HdBe-Problem)
instantiatesCanonicalΣ0..*canonical()
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)
groupIdentifierΣ0..1Identifier
courseOfTherapyType0..1CodeableConcept
insuranceI0..*Reference(Coverage | ClaimResponse)
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeΣ0..1dateTime
textΣ1..1markdown
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
eventΣ0..*dateTime
url1..1System.StringFixed Value
valueBooleanboolean
boundsRangeRange
boundsPeriodPeriod
boundsDurationΣ0..1Duration
countΣ0..1positiveInt
countMaxΣ0..1positiveInt
durationΣ0..1decimal
durationMaxΣ0..1decimal
durationUnitΣ0..1codeBinding
frequencyΣ0..1positiveInt
frequencyMaxΣ0..1positiveInt
periodΣ0..1decimal
periodMaxΣ0..1decimal
periodUnitΣ0..1codeBinding
dayOfWeekΣ0..*codeBinding
timeOfDayΣ0..*time
whenΣ0..*codeBinding
offsetΣ0..1unsignedInt
codeΣ0..1CodeableConceptBinding
asNeededBooleanboolean
asNeededCodeableConceptΣ0..1CodeableConceptBinding
siteΣ0..1CodeableConcept
routeΣ0..1CodeableConceptBinding
methodΣ0..1CodeableConcept
typeΣ0..1CodeableConcept
lowΣ I0..1SimpleQuantity
highΣ I0..1SimpleQuantity
doseQuantityΣ0..1SimpleQuantity
rateRatioRatio
lowΣ I0..1SimpleQuantity
highΣ I0..1SimpleQuantity
rateQuantityΣ0..1SimpleQuantity
maxDosePerPeriodΣ I0..1Ratio
maxDosePerAdministrationΣ I0..1SimpleQuantity
maxDosePerLifetimeΣ I0..1SimpleQuantity
quantityI0..1SimpleQuantity
durationI0..1Duration
dispenseIntervalI0..1Duration
validityPeriodI0..1Period
numberOfRepeatsAllowed0..1unsignedInt
quantityI0..1SimpleQuantity
expectedSupplyDurationI0..1Duration
performerI0..1Reference(Organization)
allowedBooleanboolean
allowedCodeableConceptCodeableConcept
reason0..1CodeableConcept
priorPrescriptionI0..1Reference(MedicationRequest)
detectedIssueI0..*Reference(DetectedIssue)
eventHistoryI0..*Reference(Provenance)

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueDurationDuration
startΣ I0..1dateTime
endΣ I0..1dateTime
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueDurationDuration
identifier0..*Identifier
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConcept
intentΣ ?!1..1codeBinding
medicationAgreementCode1..1CodeableConceptPattern
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
reportedBooleanboolean
reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
medicationCodeableConceptCodeableConcept
medicationReferenceΣ0..1Reference(Medication | HdBe-PharmaceuticalProduct)
subjectΣ I1..1Reference(Group | HdBe-Patient)
encounterI0..1Reference(Encounter)
supportingInformationI0..*Reference(Resource)
authoredOnΣ0..1dateTime
requesterΣ I0..1pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole)
performerI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)
performerTypeΣ0..1CodeableConcept
recorderI0..1Reference(Practitioner | PractitionerRole)
reasonCode0..1CodeableConceptBinding
reasonReferenceI0..1Reference(Condition | Observation | HdBe-Problem)
instantiatesCanonicalΣ0..*canonical()
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)
groupIdentifierΣ0..1Identifier
courseOfTherapyType0..1CodeableConcept
insuranceI0..*Reference(Coverage | ClaimResponse)
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeΣ0..1dateTime
textΣ1..1markdown
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
eventΣ0..*dateTime
url1..1System.StringFixed Value
valueBooleanboolean
boundsRangeRange
boundsPeriodPeriod
boundsDurationΣ0..1Duration
countΣ0..1positiveInt
countMaxΣ0..1positiveInt
durationΣ0..1decimal
durationMaxΣ0..1decimal
durationUnitΣ0..1codeBinding
frequencyΣ0..1positiveInt
frequencyMaxΣ0..1positiveInt
periodΣ0..1decimal
periodMaxΣ0..1decimal
periodUnitΣ0..1codeBinding
dayOfWeekΣ0..*codeBinding
timeOfDayΣ0..*time
whenΣ0..*codeBinding
offsetΣ0..1unsignedInt
codeΣ0..1CodeableConceptBinding
asNeededBooleanboolean
asNeededCodeableConceptΣ0..1CodeableConceptBinding
siteΣ0..1CodeableConcept
routeΣ0..1CodeableConceptBinding
methodΣ0..1CodeableConcept
typeΣ0..1CodeableConcept
lowΣ I0..1SimpleQuantity
highΣ I0..1SimpleQuantity
doseQuantityΣ0..1SimpleQuantity
rateRatioRatio
lowΣ I0..1SimpleQuantity
highΣ I0..1SimpleQuantity
rateQuantityΣ0..1SimpleQuantity
maxDosePerPeriodΣ I0..1Ratio
maxDosePerAdministrationΣ I0..1SimpleQuantity
maxDosePerLifetimeΣ I0..1SimpleQuantity
quantityI0..1SimpleQuantity
durationI0..1Duration
dispenseIntervalI0..1Duration
validityPeriodI0..1Period
numberOfRepeatsAllowed0..1unsignedInt
quantityI0..1SimpleQuantity
expectedSupplyDurationI0..1Duration
performerI0..1Reference(Organization)
allowedBooleanboolean
allowedCodeableConceptCodeableConcept
reason0..1CodeableConcept
priorPrescriptionI0..1Reference(MedicationRequest)
detectedIssueI0..*Reference(DetectedIssue)
eventHistoryI0..*Reference(Provenance)

url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueStringstring
url1..1System.StringFixed Value
url1..1System.StringFixed Value
valueDurationDuration
startΣ I0..1dateTime
endΣ I0..1dateTime
url1..1System.StringFixed Value
valueCodeableConceptCodeableConcept
url1..1System.StringFixed Value
valueDurationDuration
identifier0..*Identifier
statusΣ ?!1..1codeBinding
statusReason0..1CodeableConcept
intentΣ ?!1..1codeBinding
medicationAgreementCode1..1CodeableConceptPattern
priorityΣ0..1codeBinding
doNotPerformΣ ?!0..1boolean
reportedBooleanboolean
reportedReferenceReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
medicationCodeableConceptCodeableConcept
medicationReferenceΣ0..1Reference(Medication | HdBe-PharmaceuticalProduct)
subjectΣ I1..1Reference(Group | HdBe-Patient)
encounterI0..1Reference(Encounter)
supportingInformationI0..*Reference(Resource)
authoredOnΣ0..1dateTime
requesterΣ I0..1pattern HealthProfessional Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device | HdBe-HealthProfessional PractitionerRole)
performerI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)
performerTypeΣ0..1CodeableConcept
recorderI0..1Reference(Practitioner | PractitionerRole)
reasonCode0..1CodeableConceptBinding
reasonReferenceI0..1Reference(Condition | Observation | HdBe-Problem)
instantiatesCanonicalΣ0..*canonical()
instantiatesUriΣ0..*uri
basedOnΣ I0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)
groupIdentifierΣ0..1Identifier
courseOfTherapyType0..1CodeableConcept
insuranceI0..*Reference(Coverage | ClaimResponse)
authorStringstring
authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
timeΣ0..1dateTime
textΣ1..1markdown
sequenceΣ0..1integer
textΣ0..1string
additionalInstructionΣ0..*CodeableConcept
patientInstructionΣ0..1string
eventΣ0..*dateTime
url1..1System.StringFixed Value
valueBooleanboolean
boundsRangeRange
boundsPeriodPeriod
boundsDurationΣ0..1Duration
countΣ0..1positiveInt
countMaxΣ0..1positiveInt
durationΣ0..1decimal
durationMaxΣ0..1decimal
durationUnitΣ0..1codeBinding
frequencyΣ0..1positiveInt
frequencyMaxΣ0..1positiveInt
periodΣ0..1decimal
periodMaxΣ0..1decimal
periodUnitΣ0..1codeBinding
dayOfWeekΣ0..*codeBinding
timeOfDayΣ0..*time
whenΣ0..*codeBinding
offsetΣ0..1unsignedInt
codeΣ0..1CodeableConceptBinding
asNeededBooleanboolean
asNeededCodeableConceptΣ0..1CodeableConceptBinding
siteΣ0..1CodeableConcept
routeΣ0..1CodeableConceptBinding
methodΣ0..1CodeableConcept
typeΣ0..1CodeableConcept
lowΣ I0..1SimpleQuantity
highΣ I0..1SimpleQuantity
doseQuantityΣ0..1SimpleQuantity
rateRatioRatio
lowΣ I0..1SimpleQuantity
highΣ I0..1SimpleQuantity
rateQuantityΣ0..1SimpleQuantity
maxDosePerPeriodΣ I0..1Ratio
maxDosePerAdministrationΣ I0..1SimpleQuantity
maxDosePerLifetimeΣ I0..1SimpleQuantity
quantityI0..1SimpleQuantity
durationI0..1Duration
dispenseIntervalI0..1Duration
validityPeriodI0..1Period
numberOfRepeatsAllowed0..1unsignedInt
quantityI0..1SimpleQuantity
expectedSupplyDurationI0..1Duration
performerI0..1Reference(Organization)
allowedBooleanboolean
allowedCodeableConceptCodeableConcept
reason0..1CodeableConcept
priorPrescriptionI0..1Reference(MedicationRequest)
detectedIssueI0..*Reference(DetectedIssue)
eventHistoryI0..*Reference(Provenance)

Mapping FHIR profile to CBB

PathmapCBBcomment
MedicationRequest.extension:renderedDosageInstructionInstructionsForUse.DescriptionHdBe-InstructionsForUse
MedicationRequest.modifierExtension:repeatPeriodCyclicalScheduleInstructionsForUse.RepeatPeriodCyclicalScheduleHdBe-InstructionsForUse
MedicationRequest.modifierExtension:repeatPeriodCyclicalSchedule.value[x]InstructionsForUse.RepeatPeriodCyclicalScheduleHdBe-InstructionsForUse
MedicationRequestMedicationAgreementHdBe-MedicationAgreement
MedicationRequest.extension:medicationAgreementAdditionalInformation.value[x]MedicationAgreement.MedicationAgreementAdditionalInformationHdBe-MedicationAgreement
MedicationRequest.extension:periodOfUse.value[x]MedicationAgreement.PeriodOfUseHdBe-MedicationAgreement
MedicationRequest.modifierExtension:stopType.value[x]MedicationAgreement.MedicationAgreementStopTypeHdBe-MedicationAgreement
MedicationRequest.statusMedicationAgreement.PeriodOfUseHdBe-MedicationAgreementimplicit, main mapping is on the extensions ext-TimeInterval.Period and ext-TimeInterval.Duration
MedicationRequest.statusMedicationAgreement.MedicationAgreementStopTypeHdBe-MedicationAgreementimplicit, main mapping is on StopType extension
MedicationRequest.medication[x]:medicationReferenceMedicationAgreement.AgreedMedicineHdBe-MedicationAgreement
MedicationRequest.authoredOnMedicationAgreement.MedicationAgreementDateTimeHdBe-MedicationAgreement
MedicationRequest.requesterMedicationAgreement.PrescriberHdBe-MedicationAgreement
MedicationRequest.reasonCodeMedicationAgreement.ReasonMedicationAgreementHdBe-MedicationAgreement
MedicationRequest.reasonReferenceMedicationAgreement.PrescriptionReasonHdBe-MedicationAgreement
MedicationRequest.note.textMedicationAgreement.CommentHdBe-MedicationAgreement
MedicationRequest.dosageInstructionMedicationAgreement.InstructionsForUseHdBe-MedicationAgreement

zib MedicationAgreement difference

Concept Category Description
status textual Replaced Dutch SNOMED-CT codes with the corresponding codes in the ValueSet MedicationStopType in the guidance on the correct use of status.
reasonReference textual Removed context regarding the Dutch G-standard.
modifierExtension:stopType terminology Renamed ValueSet from MedicationAgreementStopType to MedicationStopType, to be able to reuse it at MedicationUse and AdministrationAgreement. Also replaced Dutch SNOMED-CT codes with international codes in ValueSet MedicationStopType.
reasonCode terminology Renamed ValueSet from MedicationAgreementReason to MedicationReason, to be able to reuse it at MedicationUse2. Replaced several values in ValueSet. 1. Added SNOMED-CT code for Unknown and Other. 2. Added CodeSystem MedicationReason which replaces all Dutch SNOMED-CT codes. 3. Removed all Dutch SNOMED-CT codes from valueset.
extension:medicationAgreementAdditionalInformation terminology Replaced several values in MedicationAgreementAdditionalInformation valueSet. 1. Replaced OTH with SNOMED-CT code for Other. 2. Added SNOMED-CT code for Unknown. 3. Added CodeSystem MedicationAgreementAdditionalInformation which replaces all Dutch SNOMED-CT codes. 4. Removed all Dutch SNOMED-CT codes from valueset.



Terminology Bindings

PathNameStrengthURLConceptMap
MedicationRequest.reasonCodeMedicationReasonrequiredhttps://fhir.healthdata.be/ValueSet/MedicationReasonNo bound ConceptMap