FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagebcy.ids
Resource TypeStructureDefinition
IdMedicationRequest.StructureDefinition.json
FHIR VersionR4

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source1

{
  "resourceType": "StructureDefinition",
  "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MedicationRequest",
  "name": "MedicationRequest",
  "status": "draft",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "MedicationRequest",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "MedicationRequest",
        "path": "MedicationRequest",
        "short": "FHIR resource applies for PIR Vaccine Deferrals",
        "definition": "FHIR resource applies for PIR Vaccine Deferrals"
      },
      {
        "id": "MedicationRequest.id",
        "path": "MedicationRequest.id",
        "short": "PIR internal Deferral ID",
        "definition": "PIR internal Deferral Identifier.",
        "comment": "See Mappings.",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "H33_PATIENT_VACCINE_DEFERRAL.PATIENT_VACCINE_DEFERRAL_ID"
          },
          {
            "identity": "source-PHSL",
            "map": "deferralID"
          }
        ]
      },
      {
        "id": "MedicationRequest.meta",
        "path": "MedicationRequest.meta",
        "min": 1
      },
      {
        "id": "MedicationRequest.meta.versionId",
        "path": "MedicationRequest.meta.versionId",
        "comment": "Apply \"2025.01.1\".  This indicates the FHIR Specs as of year 2025 Jan."
      },
      {
        "id": "MedicationRequest.meta.lastUpdated",
        "path": "MedicationRequest.meta.lastUpdated",
        "comment": "Updated: Relax the previously crossed-out elements."
      },
      {
        "id": "MedicationRequest.meta.profile",
        "path": "MedicationRequest.meta.profile",
        "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MedicationRequest\"",
        "min": 1,
        "max": "1"
      },
      {
        "id": "MedicationRequest.meta.security",
        "path": "MedicationRequest.meta.security",
        "max": "1"
      },
      {
        "id": "MedicationRequest.meta.tag",
        "path": "MedicationRequest.meta.tag",
        "max": "1"
      },
      {
        "id": "MedicationRequest.contained",
        "path": "MedicationRequest.contained",
        "max": "1"
      },
      {
        "id": "MedicationRequest.extension",
        "path": "MedicationRequest.extension",
        "min": 2
      },
      {
        "id": "MedicationRequest.extension:pIRIdentifierExtension",
        "path": "MedicationRequest.extension",
        "sliceName": "pIRIdentifierExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "MedicationRequest.extension:pIRLockSeqNumberExtension",
        "path": "MedicationRequest.extension",
        "sliceName": "pIRLockSeqNumberExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "MedicationRequest.identifier",
        "path": "MedicationRequest.identifier",
        "short": "PIR internal Deferral ID + External Deferral ID from source system(s)",
        "definition": "PIR internal Deferral Identifier + External Deferral ID from source system(s)",
        "min": 1
      },
      {
        "id": "MedicationRequest.identifier.type.coding",
        "path": "MedicationRequest.identifier.type.coding",
        "max": "0"
      },
      {
        "id": "MedicationRequest.identifier.type.text",
        "path": "MedicationRequest.identifier.type.text",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "PANORAMAIMMZDEFERID"
          }
        ]
      },
      {
        "id": "MedicationRequest.identifier.system",
        "path": "MedicationRequest.identifier.system",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-deferral-id"
          }
        ]
      },
      {
        "id": "MedicationRequest.identifier.value",
        "path": "MedicationRequest.identifier.value",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "H33_PATIENT_VACCINE_DEFERRAL.PATIENT_VACCINE_DEFERRAL_ID"
          }
        ]
      },
      {
        "id": "MedicationRequest.status",
        "path": "MedicationRequest.status",
        "short": "PIR applies: | active | cancelled |",
        "definition": "PIR applies possible statuses : | active | cancelled |",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "source-PIR-active",
            "map": "active"
          },
          {
            "identity": "source-PIR-deleted",
            "map": "cancelled"
          }
        ]
      },
      {
        "id": "MedicationRequest.status.extension:_status",
        "path": "MedicationRequest.status.extension",
        "sliceName": "_status",
        "comment": "To be applied if Deferral has been deleted in PIR",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/deferral-status"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "MedicationRequest.status.extension:_status.extension:deferralDeleteReason",
        "path": "MedicationRequest.status.extension.extension",
        "sliceName": "deferralDeleteReason",
        "comment": "To be applied if Deferral has been deleted with reason in PIR drop-down list or NO Delete Reason provided.",
        "mapping": [
          {
            "identity": "source-PIR-nullReason",
            "map": "Other"
          }
        ]
      },
      {
        "id": "MedicationRequest.status.extension:_status.extension:deferralDeleteReasonOther",
        "path": "MedicationRequest.status.extension.extension",
        "sliceName": "deferralDeleteReasonOther",
        "comment": "To be applied when Deferral has been deleted with OTHER reason not listed in PIR drop-down list or NO deletion reason is provided.  See Mappings.",
        "mapping": [
          {
            "identity": "source-PIR-null",
            "map": "unknown"
          }
        ]
      },
      {
        "id": "MedicationRequest.statusReason",
        "path": "MedicationRequest.statusReason",
        "short": "PIR Deferral Reason",
        "definition": "PIR Deferral Reason",
        "comment": "Reason for Deferral",
        "min": 1
      },
      {
        "id": "MedicationRequest.statusReason.coding",
        "path": "MedicationRequest.statusReason.coding",
        "min": 1,
        "max": "1"
      },
      {
        "id": "MedicationRequest.statusReason.coding.id",
        "path": "MedicationRequest.statusReason.coding.id",
        "max": "0"
      },
      {
        "id": "MedicationRequest.statusReason.coding.system",
        "path": "MedicationRequest.statusReason.coding.system",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
          }
        ]
      },
      {
        "id": "MedicationRequest.statusReason.coding.version",
        "path": "MedicationRequest.statusReason.coding.version",
        "max": "0"
      },
      {
        "id": "MedicationRequest.statusReason.coding.code",
        "path": "MedicationRequest.statusReason.coding.code",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_PATIENT_VACCINE_DEFERRAL.DEFERRAL_REASON_CD_CNCPT_ID)"
          },
          {
            "identity": "source-PHSL",
            "map": "reasonCode"
          }
        ]
      },
      {
        "id": "MedicationRequest.statusReason.coding.display",
        "path": "MedicationRequest.statusReason.coding.display",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "REPORTNG.GET_ITERM_DESC (H33_PATIENT_VACCINE_DEFERRAL.DEFERRAL_REASON_CD_CNCPT_ID)"
          },
          {
            "identity": "source-PHSL",
            "map": "reasonDescription"
          }
        ]
      },
      {
        "id": "MedicationRequest.statusReason.coding.userSelected",
        "path": "MedicationRequest.statusReason.coding.userSelected",
        "max": "0"
      },
      {
        "id": "MedicationRequest.intent",
        "path": "MedicationRequest.intent",
        "short": "PIR applies | order | for FHIR purposes",
        "definition": "PIR applies | order | for FHIR purposes",
        "comment": "Apply \"order\""
      },
      {
        "id": "MedicationRequest.category",
        "path": "MedicationRequest.category",
        "max": "1"
      },
      {
        "id": "MedicationRequest.doNotPerform",
        "path": "MedicationRequest.doNotPerform",
        "short": "True if request is deferring vaccine",
        "definition": "If true indicates that the provider is asking for the vaccine not to occur.",
        "comment": "Apply \"true\" for deferral.",
        "min": 1
      },
      {
        "id": "MedicationRequest.medication[x]",
        "path": "MedicationRequest.medication[x]",
        "short": "Vaccine to be deferred",
        "definition": "Agent/antigen vaccine to be deferred",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "MedicationRequest.medication[x].coding",
        "path": "MedicationRequest.medication[x].coding",
        "short": "1st instance Agent in NVC code, 2nd instance Agent in PIR code",
        "definition": "1st instance Agent in NVC code, 2nd instance Agent in PIR code",
        "comment": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "MedicationRequest.medication[x].coding.system",
        "path": "MedicationRequest.medication[x].coding.system",
        "comment": "1st instance Agent in NVC code, 2nd instance Agent in PIR code.  See Mappings.",
        "min": 1,
        "mapping": [
          {
            "identity": "code-NVC",
            "map": "https://nvc-cnv.canada.ca"
          },
          {
            "identity": "code-PIR",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
          }
        ]
      },
      {
        "id": "MedicationRequest.medication[x].coding.code",
        "path": "MedicationRequest.medication[x].coding.code",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_PATIENT_VACCINE_DEFERRAL.ASIIS_VACC_CODE)"
          },
          {
            "identity": "source-PHSL",
            "map": "agentCode"
          }
        ]
      },
      {
        "id": "MedicationRequest.medication[x].coding.display",
        "path": "MedicationRequest.medication[x].coding.display",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "REPORTNG.GET_ITERM_DESC (H33_PATIENT_VACCINE_DEFERRAL.ASIIS_VACC_CODE)"
          },
          {
            "identity": "source-PHSL",
            "map": "agentDescription"
          }
        ]
      },
      {
        "id": "MedicationRequest.medication[x].text",
        "path": "MedicationRequest.medication[x].text",
        "max": "0"
      },
      {
        "id": "MedicationRequest.subject.reference",
        "path": "MedicationRequest.subject.reference",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "fullURL of Panorama + \"Patient\" + PIR Client ID"
          }
        ]
      },
      {
        "id": "MedicationRequest.supportingInformation",
        "path": "MedicationRequest.supportingInformation",
        "max": "1"
      },
      {
        "id": "MedicationRequest.reasonCode",
        "path": "MedicationRequest.reasonCode",
        "max": "1"
      },
      {
        "id": "MedicationRequest.reasonReference",
        "path": "MedicationRequest.reasonReference",
        "max": "1"
      },
      {
        "id": "MedicationRequest.instantiatesCanonical",
        "path": "MedicationRequest.instantiatesCanonical",
        "max": "1"
      },
      {
        "id": "MedicationRequest.instantiatesUri",
        "path": "MedicationRequest.instantiatesUri",
        "max": "1"
      },
      {
        "id": "MedicationRequest.basedOn",
        "path": "MedicationRequest.basedOn",
        "max": "1"
      },
      {
        "id": "MedicationRequest.insurance",
        "path": "MedicationRequest.insurance",
        "max": "1"
      },
      {
        "id": "MedicationRequest.note",
        "path": "MedicationRequest.note",
        "short": "Comments about the deferral.",
        "definition": "Comments about the deferral.",
        "comment": "See Mappings",
        "max": "1",
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "Comments"
          }
        ]
      },
      {
        "id": "MedicationRequest.note.id",
        "path": "MedicationRequest.note.id",
        "max": "0"
      },
      {
        "id": "MedicationRequest.note.extension",
        "path": "MedicationRequest.note.extension",
        "min": 2
      },
      {
        "id": "MedicationRequest.note.extension:pIRIdentifierExtension",
        "path": "MedicationRequest.note.extension",
        "sliceName": "pIRIdentifierExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "MedicationRequest.note.extension:pIRLockSeqNumberExtension",
        "path": "MedicationRequest.note.extension",
        "sliceName": "pIRLockSeqNumberExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "MedicationRequest.note.author[x]",
        "path": "MedicationRequest.note.author[x]",
        "max": "0"
      },
      {
        "id": "MedicationRequest.note.text",
        "path": "MedicationRequest.note.text",
        "comment": "Deferral Comments."
      },
      {
        "id": "MedicationRequest.dosageInstruction",
        "path": "MedicationRequest.dosageInstruction",
        "max": "1"
      },
      {
        "id": "MedicationRequest.dispenseRequest",
        "path": "MedicationRequest.dispenseRequest",
        "short": "Deferral date range authorized.",
        "definition": "Deferral date range authorized..  Note Start Date is mandatory but End Date is optional.",
        "min": 1
      },
      {
        "id": "MedicationRequest.dispenseRequest.validityPeriod",
        "path": "MedicationRequest.dispenseRequest.validityPeriod",
        "min": 1
      },
      {
        "id": "MedicationRequest.dispenseRequest.validityPeriod.start",
        "path": "MedicationRequest.dispenseRequest.validityPeriod.start",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "IMMS.H33_PATIENT_VACCINE_DEFERRAL.DEFERRAL_DATE"
          },
          {
            "identity": "source-PHSL",
            "map": "deffFrom"
          }
        ]
      },
      {
        "id": "MedicationRequest.dispenseRequest.validityPeriod.end",
        "path": "MedicationRequest.dispenseRequest.validityPeriod.end",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "IMMS.H33_PATIENT_VACCINE_DEFERRAL.DEFERRAL_END_DATE"
          },
          {
            "identity": "source-PHSL",
            "map": "deffTo"
          }
        ]
      },
      {
        "id": "MedicationRequest.detectedIssue",
        "path": "MedicationRequest.detectedIssue",
        "max": "1"
      },
      {
        "id": "MedicationRequest.eventHistory",
        "path": "MedicationRequest.eventHistory",
        "max": "1"
      }
    ]
  }
}