International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPAMedicationRequest

Minimum expectations for a MedicationRequest resource when accessed via a International Patient Access API

The official URL for this profile is: 

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medicationrequest

Formal Views of Profile Content

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

This structure is derived from MedicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierExternal ids for this request
... status ?!SΣI1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason I0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!SΣI1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required)
... category I0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if request is prohibiting action
... reported[x] SΣI0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(IPA-Patient | IPA-Practitioner | IPA-PractitionerRole | IPA-Organization | IPA-RelatedPerson)
... medication[x] SΣI1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(IPA-Medication)
... subject SΣI1..1Reference(IPA-Patient)Who or group medication request is for
... encounter SI0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation I0..*Reference(Resource)Information to support ordering of the medication
... authoredOn SΣI1..1dateTimeWhen request was initially authored
... requester SΣI1..1Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Organization | IPA-Patient | IPA-Device | IPA-RelatedPerson)Who/What requested the Request
... performer I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType ΣI0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example)
... recorder I0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode I0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference I0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical ΣI0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... courseOfTherapyType I0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example)
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note I0..*AnnotationInformation about the prescription
... dosageInstruction SI0..*DosageHow the medication should be taken
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence ΣI0..1integerThe order of the dosage instructions
.... text SΣI0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction ΣI0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction ΣI0..1stringPatient or consumer oriented instructions
.... timing ΣI0..1TimingWhen medication should be administered
.... asNeeded[x] ΣI0..1Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site ΣI0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route ΣI0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method ΣI0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] ΣI0..1Amount of medication per dose
...... doseRangeRange
...... doseQuantityQuantity(SimpleQuantity)
..... rate[x] ΣI0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod ΣI0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration ΣI0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime ΣI0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... dispenseRequest I0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill I0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity I0..1SimpleQuantityFirst fill quantity
..... duration I0..1DurationFirst fill duration
.... dispenseInterval I0..1DurationMinimum period of time between dispenses
.... validityPeriod I0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed I0..1unsignedIntNumber of refills authorized
.... quantity I0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration I0..1DurationNumber of days supply per dispense
.... performer I0..1Reference(Organization)Intended dispenser
... substitution I0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] I1..1Whether substitution is allowed or not
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason I0..1CodeableConceptWhy should (not) substitution be made
Binding: V3 Value SetSubstanceAdminSubstitutionReason (example)
... priorPrescription I0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue I0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory I0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

This structure is derived from MedicationRequest

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationRequest I0..*MedicationRequestOrdering of medication for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierExternal ids for this request
... status ?!SΣI1..1codeactive | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
Binding: medicationrequest Status (required)
... statusReason I0..1CodeableConceptReason for current status
Binding: medicationRequest Status Reason Codes (example)
... intent ?!SΣI1..1codeproposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: medicationRequest Intent (required)
... category I0..*CodeableConceptType of medication usage
Binding: medicationRequest Category Codes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if request is prohibiting action
... reported[x] SΣI0..1Reported rather than primary record
.... reportedBooleanboolean
.... reportedReferenceReference(IPA-Patient | IPA-Practitioner | IPA-PractitionerRole | IPA-Organization | IPA-RelatedPerson)
... medication[x] SΣI1..1Medication to be taken
Binding: SNOMEDCTMedicationCodes (example)
.... medicationCodeableConceptCodeableConcept
.... medicationReferenceReference(IPA-Medication)
... subject SΣI1..1Reference(IPA-Patient)Who or group medication request is for
... encounter SI0..1Reference(Encounter)Encounter created as part of encounter/admission/stay
... supportingInformation I0..*Reference(Resource)Information to support ordering of the medication
... authoredOn SΣI1..1dateTimeWhen request was initially authored
... requester SΣI1..1Reference(IPA-Practitioner | IPA-PractitionerRole | IPA-Organization | IPA-Patient | IPA-Device | IPA-RelatedPerson)Who/What requested the Request
... performer I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | CareTeam)Intended performer of administration
... performerType ΣI0..1CodeableConceptDesired kind of performer of the medication administration
Binding: ProcedurePerformerRoleCodes (example)
... recorder I0..1Reference(Practitioner | PractitionerRole)Person who entered the request
... reasonCode I0..*CodeableConceptReason or indication for ordering or not ordering the medication
Binding: Condition/Problem/DiagnosisCodes (example)
... reasonReference I0..*Reference(Condition | Observation)Condition or observation that supports why the prescription is being written
... instantiatesCanonical ΣI0..*canonical()Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation)What request fulfills
... groupIdentifier ΣI0..1IdentifierComposite request this is part of
... courseOfTherapyType I0..1CodeableConceptOverall pattern of medication administration
Binding: medicationRequest Course of Therapy Codes (example)
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... note I0..*AnnotationInformation about the prescription
... dosageInstruction SI0..*DosageHow the medication should be taken
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... sequence ΣI0..1integerThe order of the dosage instructions
.... text SΣI0..1stringFree text dosage instructions e.g. SIG
.... additionalInstruction ΣI0..*CodeableConceptSupplemental instruction or warnings to the patient - e.g. "with meals", "may cause drowsiness"
Binding: SNOMEDCTAdditionalDosageInstructions (example)
.... patientInstruction ΣI0..1stringPatient or consumer oriented instructions
.... timing ΣI0..1TimingWhen medication should be administered
.... asNeeded[x] ΣI0..1Take "as needed" (for x)
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
..... asNeededBooleanboolean
..... asNeededCodeableConceptCodeableConcept
.... site ΣI0..1CodeableConceptBody site to administer to
Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example)
.... route ΣI0..1CodeableConceptHow drug should enter body
Binding: SNOMEDCTRouteCodes (example)
.... method ΣI0..1CodeableConceptTechnique for administering medication
Binding: SNOMEDCTAdministrationMethodCodes (example)
.... doseAndRate ΣI0..*ElementAmount of medication administered
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... type ΣI0..1CodeableConceptThe kind of dose or rate specified
Binding: DoseAndRateType (example)
..... dose[x] ΣI0..1Amount of medication per dose
...... doseRangeRange
...... doseQuantityQuantity(SimpleQuantity)
..... rate[x] ΣI0..1Amount of medication per unit of time
...... rateRatioRatio
...... rateRangeRange
...... rateQuantityQuantity(SimpleQuantity)
.... maxDosePerPeriod ΣI0..1RatioUpper limit on medication per unit of time
.... maxDosePerAdministration ΣI0..1SimpleQuantityUpper limit on medication per administration
.... maxDosePerLifetime ΣI0..1SimpleQuantityUpper limit on medication per lifetime of the patient
... dispenseRequest I0..1BackboneElementMedication supply authorization
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... initialFill I0..1BackboneElementFirst fill details
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... quantity I0..1SimpleQuantityFirst fill quantity
..... duration I0..1DurationFirst fill duration
.... dispenseInterval I0..1DurationMinimum period of time between dispenses
.... validityPeriod I0..1PeriodTime period supply is authorized for
.... numberOfRepeatsAllowed I0..1unsignedIntNumber of refills authorized
.... quantity I0..1SimpleQuantityAmount of medication to supply per dispense
.... expectedSupplyDuration I0..1DurationNumber of days supply per dispense
.... performer I0..1Reference(Organization)Intended dispenser
... substitution I0..1BackboneElementAny restrictions on medication substitution
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... allowed[x] I1..1Whether substitution is allowed or not
Binding: V3 Value SetActSubstanceAdminSubstitutionCode (example)
..... allowedBooleanboolean
..... allowedCodeableConceptCodeableConcept
.... reason I0..1CodeableConceptWhy should (not) substitution be made
Binding: V3 Value SetSubstanceAdminSubstitutionReason (example)
... priorPrescription I0..1Reference(MedicationRequest)An order/prescription that is being replaced
... detectedIssue I0..*Reference(DetectedIssue)Clinical Issue with action
... eventHistory I0..*Reference(Provenance)A list of events of interest in the lifecycle

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
MedicationRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
MedicationRequest.statusrequiredmedicationrequest Status
MedicationRequest.statusReasonexamplemedicationRequest Status Reason Codes
MedicationRequest.intentrequiredmedicationRequest Intent
MedicationRequest.categoryexamplemedicationRequest Category Codes
MedicationRequest.priorityrequiredRequestPriority
MedicationRequest.medication[x]exampleSNOMEDCTMedicationCodes
MedicationRequest.performerTypeexampleProcedurePerformerRoleCodes
MedicationRequest.reasonCodeexampleCondition/Problem/DiagnosisCodes
MedicationRequest.courseOfTherapyTypeexamplemedicationRequest Course of Therapy Codes
MedicationRequest.dosageInstruction.additionalInstructionexampleSNOMEDCTAdditionalDosageInstructions
MedicationRequest.dosageInstruction.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
MedicationRequest.dosageInstruction.siteexampleSNOMEDCTAnatomicalStructureForAdministrationSiteCodes
MedicationRequest.dosageInstruction.routeexampleSNOMEDCTRouteCodes
MedicationRequest.dosageInstruction.methodexampleSNOMEDCTAdministrationMethodCodes
MedicationRequest.dosageInstruction.doseAndRate.typeexampleDoseAndRateType
MedicationRequest.substitution.allowed[x]examplev3.ActSubstanceAdminSubstitutionCode
MedicationRequest.substitution.reasonexamplev3.SubstanceAdminSubstitutionReason

Constraints

Constraints

IdPathDetailsRequirements