FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/zib-AdministrationAgreement

Packagenictiz.fhir.nl.stu3.zib2015
Resource TypeStructureDefinition
Idzib-AdministrationAgreement
FHIR VersionR3
Sourcehttps://simplifier.net/resolve?scope=nictiz.fhir.nl.stu3.zib2015@1.0.0&canonical=http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement
URLhttp://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement
Version1.0
Statusretired
Date2016-12-12T16:39:05.96+00:00
NameZIB-AdministrationAgreement
TitleHCIM Administration Agreement
Realmnl
Authorityhl7
DescriptionThis profile is based on the Dutch Health and Care Information (HCIM) models (Dutch: Zorginformatiebouwsteen or ZIB) nl.zorg.Verstrekking version 1.0, year 2017.
PurposeThe goal of the administration agreement is to provide insight into the concrete instructions for administration/use of medication.
CopyrightCC0
TypeMedicationDispense
Kindresource

Resources that use this resource

StructureDefinition
Bundle-MedicationOverviewMedication Overview response structure
MedicationOverviewMedication Overview
zib-MedicationAdministrationHCIM Medication Administration

Resources that this resource uses

StructureDefinition
zib-AdministrationAgreement-AgreementReasonHCIM Reason For Dispense
nl-core-episodeofcarenl-core-episodeofcare
nl-core-organizationnl-core-organization
nl-core-patientnl-core-patient
nl-core-practitionernl-core-practitioner
nl-core-relatedpersonnl-core-relatedperson
zib-AdministrationAgreement-AuthoredOnHCIM Authored On
zib-ContactHCIM Contact
zib-InstructionsForUseHCIM InstructionsForUse
zib-Medication-AdditionalInformationHCIM AdditionalInformation
zib-Medication-MedicationTreatmentZIB Medication Treatment
zib-Medication-PeriodOfUseHCIM Medication Period Of Use
zib-Medication-StopTypeHCIM Medication StopType
zib-MedicationUse-DurationHCIM Medication Use Duration
zib-ProductHCIM Product
ValueSet
2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000ToedieningsafspraakAanvullendeInformatieCodelijst

Narrative

No narrative content found in resource


Source

{
  "resourceType": "StructureDefinition",
  "id": "zib-AdministrationAgreement",
  "meta": {
    "versionId": "3",
    "lastUpdated": "2017-12-06T15:16:05.282+01:00"
  },
  "url": "http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement",
  "version": "1.0",
  "name": "ZIB-AdministrationAgreement",
  "title": "HCIM Administration Agreement",
  "status": "retired",
  "date": "2016-12-12T16:39:05.96+00:00",
  "publisher": "Nictiz",
  "contact": [
    {
      "name": "Nictiz",
      "telecom": [
        {
          "system": "email",
          "value": "info@nictiz.nl",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This profile is based on the Dutch Health and Care Information (HCIM) models (Dutch: Zorginformatiebouwsteen or ZIB) nl.zorg.Verstrekking version 1.0, year 2017.",
  "purpose": "The goal of the administration agreement is to provide insight into the concrete instructions for administration/use of medication.",
  "copyright": "CC0",
  "fhirVersion": "3.0.1",
  "mapping": [
    {
      "identity": "hcim-administrationagreement-v1.0-2017EN",
      "uri": "https://zibs.nl/wiki/AdministrationAgreement-v1.0(2017EN)",
      "name": "HCIM AdministrationAgreement-v1.0(2017EN)"
    },
    {
      "identity": "Medication-Process-v09",
      "uri": "https://decor.nictiz.nl/medicatieproces/mp-html-20170829T141253/ds-2.16.840.1.113883.2.4.3.11.60.20.77.1.3-2016-06-01T000000.html",
      "name": "Medication Process v09",
      "comment": "Language of Medication Process is Dutch."
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "MedicationDispense",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "MedicationDispense",
        "path": "MedicationDispense",
        "short": "AdministrationAgreement",
        "definition": "An administration agreement is the use (or administering) instructions from the pharmacist to the patient (or their representative or administrator), whereby a medication agreement is structured at a concrete level.",
        "alias": [
          "Toedieningsafspraak"
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.20132"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension",
        "path": "MedicationDispense.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationDispense.extension:usageDuration",
        "path": "MedicationDispense.extension",
        "sliceName": "usageDuration",
        "short": "Duration",
        "definition": "The intended duration of use. E.g. 5 days or 8 weeks. It is not allowed to indicate the duration in months, because different months have a variable duration in days.",
        "alias": [
          "Gebruiksduur"
        ],
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-MedicationUse-Duration"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22660"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:usageDuration.valueDuration:valueDuration",
        "path": "MedicationDispense.extension.valueDuration",
        "sliceName": "valueDuration"
      },
      {
        "id": "MedicationDispense.extension:authoredOn",
        "path": "MedicationDispense.extension",
        "sliceName": "authoredOn",
        "short": "AdministrationAgreementDateTime",
        "definition": "The time at which the agreement was made.",
        "alias": [
          "ToedieningsafspraakDatumTijd"
        ],
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AuthoredOn"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.20133"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:authoredOn.valueDateTime:valueDateTime",
        "path": "MedicationDispense.extension.valueDateTime",
        "sliceName": "valueDateTime"
      },
      {
        "id": "MedicationDispense.extension:agreementReason",
        "path": "MedicationDispense.extension",
        "sliceName": "agreementReason",
        "short": "AgreementReason",
        "definition": "Reason for this agreement. This will often be the same reason as the one for the medication agreement. \r\nThis field has the option to - if applicable - enter a specific reason for the administration agreement. Examples include: substitution, transfer to GDS, patient request for different product, etc",
        "alias": [
          "RedenAfspraak"
        ],
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-AdministrationAgreement-AgreementReason"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22499"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:agreementReason.valueString:valueString",
        "path": "MedicationDispense.extension.valueString",
        "sliceName": "valueString"
      },
      {
        "id": "MedicationDispense.extension:periodOfUse",
        "path": "MedicationDispense.extension",
        "sliceName": "periodOfUse",
        "short": "PeriodOfUse",
        "definition": "Optional Extensions Element - found in all resources.",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22660"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:additionalInformation",
        "path": "MedicationDispense.extension",
        "sliceName": "additionalInformation",
        "short": "AdministrationAgreementAdditionalInformation",
        "definition": "Additional information includes details on the structure of the agreement made. \r\n\r\nThis element mainly contains information that until now has been structured with ZZ rules. The medication-related topics that are now supported by the ZZ rules are best supported with a system functionality. A process has been started for this by Z-index/KNMP. For now, the following list will be used. This list will be replaced by a thesaurus in the G standard at a later stage.",
        "alias": [
          "ToedieningsafspraakAanvullendeInformatie"
        ],
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-AdditionalInformation"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.23284"
          }
        ]
      },
      {
        "id": "MedicationDispense.extension:additionalInformation.valueCodeableConcept:valueCodeableConcept",
        "path": "MedicationDispense.extension.valueCodeableConcept",
        "sliceName": "valueCodeableConcept",
        "example": [
          {
            "label": "Example of AdditionalInformation",
            "valueCodeableConcept": {
              "coding": [
                {
                  "code": "4",
                  "display": "Medicatieafspraak gewijzigd: dosering"
                }
              ]
            }
          }
        ],
        "binding": {
          "strength": "extensible",
          "description": "AdministrationAgreementAdditionalInformation",
          "valueSetReference": {
            "reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.9.8.2--20171231000000"
          }
        }
      },
      {
        "id": "MedicationDispense.extension:medicationTreatment",
        "path": "MedicationDispense.extension",
        "sliceName": "medicationTreatment",
        "short": "Medication Treatment",
        "definition": "This extension is to describe which overarching medication treatment this information is part of. This is done by the use of an identifier of that medication treatment.",
        "comment": "No HCIM concept is available for this element. Therefore a mapping to the relevant element Medication Process data element is provided.",
        "alias": [
          "Medicamenteuze behandeling"
        ],
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-MedicationTreatment"
          }
        ],
        "mapping": [
          {
            "identity": "Medication-Process-v09",
            "map": "mp-dataelement900-22092"
          }
        ]
      },
      {
        "id": "MedicationDispense.modifierExtension",
        "path": "MedicationDispense.modifierExtension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationDispense.modifierExtension:stopType",
        "path": "MedicationDispense.modifierExtension",
        "sliceName": "stopType",
        "short": "AdministrationAgreementStopType",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-Medication-StopType"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22498"
          }
        ]
      },
      {
        "id": "MedicationDispense.modifierExtension:stopType.valueCodeableConcept:valueCodeableConcept",
        "path": "MedicationDispense.modifierExtension.valueCodeableConcept",
        "sliceName": "valueCodeableConcept",
        "binding": {
          "strength": "required"
        }
      },
      {
        "id": "MedicationDispense.identifier",
        "path": "MedicationDispense.identifier",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "system"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationDispense.identifier:AdministrationAgreementIdentifier",
        "path": "MedicationDispense.identifier",
        "sliceName": "AdministrationAgreementIdentifier",
        "max": "1"
      },
      {
        "id": "MedicationDispense.status",
        "path": "MedicationDispense.status",
        "short": "CanceledIndicator",
        "definition": "In the event of an error correction, the value of this element shall be 'entered-in-error'.",
        "alias": [
          "GeannuleerdIndicator"
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.23034"
          }
        ]
      },
      {
        "id": "MedicationDispense.category",
        "path": "MedicationDispense.category",
        "min": 1
      },
      {
        "id": "MedicationDispense.category.coding",
        "path": "MedicationDispense.category.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "code"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "MedicationDispense.category.coding:AdministrationAgreementCode",
        "path": "MedicationDispense.category.coding",
        "sliceName": "AdministrationAgreementCode",
        "short": "AdministrationAgreementCode",
        "definition": "Category snomed code used for indexing/retrieval of the ZIB AdministrationAgremeent. The snomed code 422037009 for this resource is stated in the Medication Process v09.",
        "max": "1"
      },
      {
        "id": "MedicationDispense.category.coding:AdministrationAgreementCode.system",
        "path": "MedicationDispense.category.coding.system",
        "fixedUri": "http://snomed.info/sct"
      },
      {
        "id": "MedicationDispense.category.coding:AdministrationAgreementCode.code",
        "path": "MedicationDispense.category.coding.code",
        "fixedCode": "422037009"
      },
      {
        "id": "MedicationDispense.category.coding:AdministrationAgreementCode.display",
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
            "valueBoolean": true
          }
        ],
        "path": "MedicationDispense.category.coding.display",
        "fixedString": "Provider medication administration instructions (procedure)"
      },
      {
        "id": "MedicationDispense.medication[x]",
        "path": "MedicationDispense.medication[x]",
        "short": "MedicineForAdministrationAgreement",
        "definition": "Medicine in the AdministrationAgreement.",
        "alias": [
          "GeneesmiddelBijToedieningsAfspraak",
          "Product"
        ],
        "type": [
          {
            "code": "CodeableConcept"
          },
          {
            "code": "Reference",
            "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-Product"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.20237"
          }
        ]
      },
      {
        "id": "MedicationDispense.subject",
        "path": "MedicationDispense.subject",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
          }
        ]
      },
      {
        "id": "MedicationDispense.context",
        "path": "MedicationDispense.context",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-Contact"
          },
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-episodeofcare"
          }
        ]
      },
      {
        "id": "MedicationDispense.supportingInformation",
        "path": "MedicationDispense.supportingInformation",
        "short": "MedicationAgreement",
        "definition": "Relationship to the medication agreement on which the administration agreement is based.",
        "alias": [
          "Medicatieafspraak"
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22394"
          }
        ]
      },
      {
        "id": "MedicationDispense.performer",
        "path": "MedicationDispense.performer",
        "short": "Supplier",
        "definition": "The supplier (pharmacist) that entered the administration agreement.",
        "alias": [
          "Verstrekker"
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22097"
          }
        ]
      },
      {
        "id": "MedicationDispense.performer.actor",
        "path": "MedicationDispense.performer.actor",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner"
          },
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-organization"
          },
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-patient"
          },
          {
            "code": "Reference",
            "targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
          },
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-relatedperson"
          }
        ]
      },
      {
        "id": "MedicationDispense.performer.onBehalfOf",
        "path": "MedicationDispense.performer.onBehalfOf",
        "type": [
          {
            "code": "Reference",
            "targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-organization"
          }
        ]
      },
      {
        "id": "MedicationDispense.note",
        "path": "MedicationDispense.note",
        "short": "Comment",
        "definition": "Comments on the administration agreement.",
        "alias": [
          "Toelichting"
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22275"
          }
        ]
      },
      {
        "id": "MedicationDispense.dosageInstruction",
        "path": "MedicationDispense.dosageInstruction",
        "type": [
          {
            "code": "Dosage",
            "profile": "http://nictiz.nl/fhir/StructureDefinition/zib-InstructionsForUse"
          }
        ],
        "mapping": [
          {
            "identity": "hcim-administrationagreement-v1.0-2017EN",
            "map": "NL-CM:9.8.22098"
          }
        ]
      },
      {
        "id": "MedicationDispense.dosageInstruction.dose[x]",
        "path": "MedicationDispense.dosageInstruction.dose[x]",
        "slicing": {
          "discriminator": [
            {
              "type": "type",
              "path": "$this"
            }
          ],
          "rules": "open"
        }
      }
    ]
  }
}