diff --git a/extensions/industry/healthcare/fhir/fieldgroups/medicationdispense.example.1.json b/extensions/industry/healthcare/fhir/fieldgroups/medicationdispense.example.1.json new file mode 100644 index 000000000..6ea204726 --- /dev/null +++ b/extensions/industry/healthcare/fhir/fieldgroups/medicationdispense.example.1.json @@ -0,0 +1,83 @@ +{ + "status" : "in-progress", + "medication" : { + "concept" : { + "coding" : [{ + "system" : "http://www.nlm.nih.gov/research/umls/rxnorm", + "code" : "226827", + "display" : "Azithromycin 500mg oral tablet (Zithromax)" + }] + } + }, + "subject" : { + "reference" : "Patient/pat1", + "display" : "Donald Duck" + }, + "performer" : [{ + "actor" : { + "reference" : "Practitioner/f006" + } + }], + "authorizingPrescription" : [{ + "reference" : "MedicationRequest/medrx0313" + }], + "type" : { + "coding" : [{ + "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "code" : "TF", + "display" : "trial Fill" + }] + }, + "quantity" : { + "value" : 5, + "system" : "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm", + "code" : "TAB" + }, + "daysSupply" : { + "value" : 5, + "unit" : "Day", + "system" : "http://unitsofmeasure.org", + "code" : "d" + }, + "whenPrepared" : "2024-08-29T10:20:00Z", + "dosageInstruction" : [{ + "sequence" : 1, + "text" : "500mg daily for 5 days", + "additionalInstruction" : [{ + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "421984009", + "display" : "Until finished - dosing instruction fragment (qualifier value)" + }] + }], + "timing" : { + "repeat" : { + "frequency" : 1, + "period" : 1, + "periodUnit" : "d" + } + }, + "route" : { + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "26643006", + "display" : "Oral Route (qualifier value)" + }] + }, + "doseAndRate" : [{ + "type" : { + "coding" : [{ + "system" : "http://terminology.hl7.org/CodeSystem/dose-rate-type", + "code" : "ordered", + "display" : "Ordered" + }] + }, + "doseQuantity" : { + "value" : 500, + "unit" : "mg", + "system" : "http://unitsofmeasure.org", + "code" : "mg" + } + }] + }] +} diff --git a/extensions/industry/healthcare/fhir/fieldgroups/medicationdispense.schema.json b/extensions/industry/healthcare/fhir/fieldgroups/medicationdispense.schema.json new file mode 100644 index 000000000..06395012f --- /dev/null +++ b/extensions/industry/healthcare/fhir/fieldgroups/medicationdispense.schema.json @@ -0,0 +1,273 @@ +{ + "meta:license":[ + "Copyright 2024 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id":"https://ns.fhir.org/fieldgroups/medicationdispense", + "$schema":"http://json-schema.org/draft-06/schema#", + "title":"Medication", + "type":"object", + "meta:tags":{ + "industry":[ + "healthcare_services" + ] + }, + "meta:intendedToExtend":[ + "https://ns.adobe.com/xdm/classes/medication", + "https://ns.adobe.com/xdm/context/profile", + "https://ns.adobe.com/xdm/classes/provider" + ], + "meta:extensible":true, + "meta:abstract":true, + "description":"Indicates that a medication product is to be or has been dispensed for a named person/patient.(Based on HL7 FHIR Release 5 specifications)", + "definitions":{ + "medicationDispense":{ + "properties":{ + "xdm:healthcareMedicationDispense":{ + "type":"object", + "properties":{ + "xdm:identifier":{ + "title":"Identifier", + "description":"Identifiers associated with this medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/identifier" + } + }, + "xdm:basedOn":{ + "title":"Based On", + "description":"A plan that is fulfilled in whole or in part by this MedicationDispense.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:partOf":{ + "title":"Part Of", + "description":"The procedure or medication administration that triggered the dispense.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:status":{ + "title":"Status", + "description":"preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown", + "type":"string", + "enum":[ + "preparation", + "in-progress", + "cancelled", + "on-hold", + "completed", + "entered-in-error", + "stopped", + "declined", + "unknown" + ], + "meta:enum":{ + "preparation":"Preparation", + "in-progress":"In Progress", + "cancelled":"Cancelled", + "on-hold":"On Hold", + "completed":"Completed", + "entered-in-error":"Entered In Error", + "stopped":"Stopped", + "declined":"Declined", + "unknown":"Unknown" + } + }, + "xdm:notPerformedReason":{ + "title":"Not Performed Reason", + "description":"Indicates the reason why a dispense was not performed.", + "$ref":"https://ns.fhir.org/datatypes/codeablereference" + }, + "xdm:statusChanged":{ + "title":"Status Changed", + "description":"The date (and maybe time) when the status of the dispense record changed.", + "type":"string", + "format":"date-time" + }, + "xdm:category":{ + "title":"Category", + "description":"Indicates the type of medication dispense (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + } + }, + "xdm:medication":{ + "title":"Medication", + "description":"Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "$ref":"https://ns.fhir.org/datatypes/codeablereference" + }, + "xdm:subject":{ + "title":"Subject", + "description":"A link to a resource representing the person or the group to whom the medication will be given.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:encounter":{ + "title":"Encounter", + "description":"The encounter that establishes the context for this event.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:supportingInformation":{ + "title":"Supporting Information", + "description":"Additional information that supports the medication being dispensed. For example, there may be requirements that a specific lab test has been completed prior to dispensing or the patient's weight at the time of dispensing is documented.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:performer":{ + "title":"Performer", + "description":"Indicates who or what performed the event.", + "type":"array", + "items":{ + "type":"object", + "properties":{ + "xdm:function":{ + "title":"Function", + "description":"Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:actor":{ + "title":"Actor", + "description":"The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.", + "$ref":"https://ns.fhir.org/datatypes/reference" + } + } + } + }, + "xdm:location":{ + "title":"Location", + "description":"The principal physical location where the dispense was performed.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:authorizingPrescription":{ + "title":"Authorizing Prescription", + "description":"Indicates the medication order that is being dispensed against.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:type":{ + "title":"Type", + "description":"Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:quantity":{ + "title":"quantity", + "description":"The amount of medication that has been dispensed. Includes unit of measure.", + "$ref":"https://ns.fhir.org/datatypes/simplequantity" + }, + "xdm:daysSupply":{ + "title":"Days Supply", + "description":"The amount of medication expressed as a timing amount.", + "$ref":"https://ns.fhir.org/datatypes/simplequantity" + }, + "xdm:recorded":{ + "title":"Recorded", + "description":"The date (and maybe time) when the dispense activity started if whenPrepared or whenHandedOver is not populated.", + "type":"string", + "format":"date-time" + }, + "xdm:whenPrepared":{ + "title":"When Prepared", + "description":"The time when the dispensed product was packaged and reviewed.", + "type":"string", + "format":"date-time" + }, + "xdm:whenHandedOver":{ + "title":"When Handed Over", + "description":"The time the dispensed product was provided to the patient or their representative.", + "type":"string", + "format":"date-time" + }, + "xdm:destination":{ + "title":"Destination", + "description":"Identification of the facility/location where the medication was/will be shipped to, as part of the dispense event.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:receiver":{ + "title":"Receiver", + "description":"Identifies the person who picked up the medication or the location of where the medication was delivered. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:note":{ + "title":"Note", + "description":"Extra information about the dispense that could not be conveyed in the other attributes.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/annotation" + } + }, + "xdm:renderedDosageInstruction":{ + "title":"Rendered Dosage Instruction", + "description":"The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", + "type":"string" + }, + "xdm:dosageInstruction":{ + "title":"Dosage Instruction", + "description":"Indicates how the medication is to be used by the patient.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/dosage" + } + }, + "xdm:substitution":{ + "title":"Substitution", + "description":"Indicates whether or not substitution was made as part of the dispense.", + "type":"object", + "properties":{ + "xdm:wasSubstituted":{ + "title":"Was Substituted", + "description":"True if the dispenser dispensed a different drug or product from what was prescribed.", + "type":"boolean" + }, + "xdm:type":{ + "title":"Type", + "description":"A code signifying whether a different drug was dispensed from what was prescribed.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:reason":{ + "title":"Reason", + "description":"Indicates the reason for the substitution, or why substitution must or must not be performed.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + } + }, + "xdm:responsibleParty":{ + "title":"Responsible Party", + "description":"The person or organization that has primary responsibility for the substitution.", + "$ref":"https://ns.fhir.org/datatypes/reference" + } + } + }, + "xdm:eventHistory":{ + "title":"Event History", + "description":"A summary of the events of interest that have occurred, such as when the dispense was verified.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + } + } + } + } + } + }, + "allOf":[ + { + "$ref":"#/definitions/medicationDispense" + } + ], + "meta:status":"experimental" +} diff --git a/extensions/industry/healthcare/fhir/fieldgroups/medicationrequest.example.1.json b/extensions/industry/healthcare/fhir/fieldgroups/medicationrequest.example.1.json new file mode 100644 index 000000000..7d18ae572 --- /dev/null +++ b/extensions/industry/healthcare/fhir/fieldgroups/medicationrequest.example.1.json @@ -0,0 +1,164 @@ +{ + "identifier" : [{ + "use" : "official", + "system" : "http://www.bmc.nl/portal/prescriptions", + "value" : "12345689" + }], + "status" : "active", + "intent" : "order", + "medication" : { + "reference" : { + "reference" : "#med0320" + } + }, + "subject" : { + "reference" : "Patient/pat1", + "display" : "Donald Duck" + }, + "encounter" : { + "reference" : "Encounter/f001", + "display" : "encounter who leads to this prescription" + }, + "supportingInformation" : [{ + "reference" : "Coverage/SP1234" + }], + "authoredOn" : "2024-01-15", + "requester" : { + "reference" : "Practitioner/f007", + "display" : "Patrick Pump" + }, + "reason" : [{ + "concept" : { + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "11840006", + "display" : "Traveller's Diarrhea (disorder)" + }] + } + }], + "note" : [{ + "text" : "Patient told to take with food" + }], + "dosageInstruction" : [{ + "sequence" : 1, + "text" : "Two tablets at once", + "additionalInstruction" : [{ + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "311504000", + "display" : "With or after food" + }] + }], + "timing" : { + "repeat" : { + "frequency" : 1, + "period" : 1, + "periodUnit" : "d" + } + }, + "route" : { + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "26643006", + "display" : "Oral Route" + }] + }, + "method" : { + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "421521009", + "display" : "Swallow - dosing instruction imperative (qualifier value)" + }] + }, + "doseAndRate" : [{ + "type" : { + "coding" : [{ + "system" : "http://terminology.hl7.org/CodeSystem/dose-rate-type", + "code" : "ordered", + "display" : "Ordered" + }] + }, + "doseQuantity" : { + "value" : 2, + "unit" : "TAB", + "system" : "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm", + "code" : "TAB" + } + }] + }, + { + "sequence" : 2, + "text" : "One tablet daily for 4 days", + "additionalInstruction" : [{ + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "311504000", + "display" : "With or after food" + }] + }], + "timing" : { + "repeat" : { + "boundsDuration" : { + "value" : 4, + "unit" : "days", + "system" : "http://unitsofmeasure.org", + "code" : "d" + }, + "frequency" : 1, + "period" : 1, + "periodUnit" : "d" + } + }, + "route" : { + "coding" : [{ + "system" : "http://snomed.info/sct", + "code" : "26643006", + "display" : "Oral Route" + }] + }, + "doseAndRate" : [{ + "type" : { + "coding" : [{ + "system" : "http://terminology.hl7.org/CodeSystem/dose-rate-type", + "code" : "ordered", + "display" : "Ordered" + }] + }, + "doseQuantity" : { + "value" : 1, + "unit" : "TAB", + "system" : "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm", + "code" : "TAB" + } + }] + }], + "dispenseRequest" : { + "validityPeriod" : { + "start" : "2024-01-15", + "end" : "2025-01-14" + }, + "numberOfRepeatsAllowed" : 1, + "quantity" : { + "value" : 6, + "unit" : "TAB", + "system" : "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm", + "code" : "TAB" + }, + "expectedSupplyDuration" : { + "value" : 5, + "unit" : "days", + "system" : "http://unitsofmeasure.org", + "code" : "d" + } + }, + "substitution" : { + "allowedBoolean" : true, + "reason" : { + "coding" : [{ + "system" : "http://terminology.hl7.org/CodeSystem/v3-ActReason", + "code" : "FP", + "display" : "formulary policy" + }] + } + } +} diff --git a/extensions/industry/healthcare/fhir/fieldgroups/medicationrequest.schema.json b/extensions/industry/healthcare/fhir/fieldgroups/medicationrequest.schema.json new file mode 100644 index 000000000..99b47f47a --- /dev/null +++ b/extensions/industry/healthcare/fhir/fieldgroups/medicationrequest.schema.json @@ -0,0 +1,378 @@ +{ + "meta:license":[ + "Copyright 2024 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id":"https://ns.fhir.org/fieldgroups/medicationrequest", + "$schema":"http://json-schema.org/draft-06/schema#", + "title":"Medication", + "type":"object", + "meta:tags":{ + "industry":[ + "healthcare_services" + ] + }, + "meta:intendedToExtend":[ + "https://ns.adobe.com/xdm/classes/medication", + "https://ns.adobe.com/xdm/context/profile", + "https://ns.adobe.com/xdm/classes/provider" + ], + "meta:extensible":true, + "meta:abstract":true, + "description":"An order or request for both supply of the medication and the instructions for administration of the medication to a patient.(Based on HL7 FHIR Release 5 specifications)", + "definitions":{ + "medicationRequest":{ + "properties":{ + "xdm:healthcareMedicationRequest":{ + "type":"object", + "properties":{ + "xdm:identifier":{ + "title":"Identifier", + "description":"Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/identifier" + } + }, + "xdm:basedOn":{ + "title":"Based On", + "description":"A plan or request that is fulfilled in whole or in part by this medication request.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:priorPrescription":{ + "title":"Prior Prescription", + "description":"Reference to an order/prescription that is being replaced by this MedicationRequest.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:groupIdentifier":{ + "title":"Group Identifier", + "description":"A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author.", + "$ref":"https://ns.fhir.org/datatypes/identifier" + }, + "xdm:status":{ + "title":"Status", + "description":"preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown", + "type":"string", + "enum":[ + "preparation", + "in-progress", + "cancelled", + "on-hold", + "completed", + "entered-in-error", + "stopped", + "declined", + "unknown" + ], + "meta:enum":{ + "preparation":"Preparation", + "in-progress":"In Progress", + "cancelled":"Cancelled", + "on-hold":"On Hold", + "completed":"Completed", + "entered-in-error":"Entered In Error", + "stopped":"Stopped", + "declined":"Declined", + "unknown":"Unknown" + } + }, + "xdm:statusReason":{ + "title":"Status Reason", + "description":"Captures the reason for the current state of the MedicationRequest.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:statusChanged":{ + "title":"Status Changed", + "description":"The date (and perhaps time) when the status was changed.", + "type":"string", + "format":"date-time" + }, + "xdm:intent":{ + "title":"Intent", + "description":"proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option", + "type":"string", + "enum":[ + "proposal", + "plan", + "order", + "original-order", + "reflex-order", + "filler-order", + "instance-order", + "option" + ], + "meta:enum":{ + "proposal":"Proposal", + "plan":"Plan", + "order":"Order", + "original-order":"Origignal Order", + "reflex-order":"Reflex Order", + "filler-order":"Filler Order", + "instance-order":"Instance Order", + "option":"Option" + } + }, + "xdm:category":{ + "title":"Category", + "description":"An arbitrary categorization or grouping of the medication request. It could be used for indicating where meds are intended to be administered, eg. in an inpatient setting or in a patient's home, or a legal category of the medication.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + } + }, + "xdm:priority":{ + "title":"Priority", + "description":"routine | urgent | asap | stat", + "type":"string", + "enum":[ + "routine", + "urgent", + "asap", + "stat" + ], + "meta:enum":{ + "routine":"routine", + "urgent":"urgent", + "asap":"ASAP", + "stat":"STAT" + } + }, + "fhr:doNotPerform":{ + "title":"Do Not Perform", + "description":"True if patient is to stop taking or not to start taking the medication.", + "type":"boolean" + }, + "xdm:medication":{ + "title":"Medication", + "description":"Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.", + "$ref":"https://ns.fhir.org/datatypes/codeablereference" + }, + "xdm:subject":{ + "title":"Subject", + "description":"The individual or group for whom the medication has been requested.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:informationSource":{ + "title":"Information Source", + "description":"The person or organization who provided the information about this request, if the source is someone other than the requestor. This is often used when the MedicationRequest is reported by another person.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:encounter":{ + "title":"Encounter", + "description":"The Encounter during which this request was created.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:supportingInformation":{ + "title":"Supporting Information", + "description":"Information to support fulfilling (i.e. dispensing or administering) of the medication, for example, patient height and weight, a MedicationStatement for the patient).", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:authoredOn":{ + "title":"Authored On", + "description":"The date (and perhaps time) when the prescription was initially written or authored on.", + "type":"string", + "format":"date-time" + }, + "xdm:requester":{ + "title":"Requester", + "description":"The individual, organization, or device that initiated the request and has responsibility for its activation.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "fhr:reported":{ + "title":"Reported", + "description":"Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.", + "type":"boolean" + }, + "xdm:performerType":{ + "title":"Performer Type", + "description":"Indicates the type of performer of the administration of the medication.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:performer":{ + "title":"Performer", + "description":"The specified desired performer of the medication treatment (e.g. the performer of the medication administration). For devices, this is the device that is intended to perform the administration of the medication.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:device":{ + "title":"Device", + "description":"The intended type of device that is to be used for the administration of the medication (for example, PCA Pump).", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/codeablereference" + } + }, + "xdm:recorder":{ + "title":"Recorder", + "description":"The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:reason":{ + "title":"Reason", + "description":"The reason or the indication for ordering or not ordering the medication.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/codeablereference" + } + }, + "xdm:courseOfTherapyType":{ + "title":"Course Of Therapy Type", + "description":"The description of the overall pattern of the administration of the medication to the patient.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:insurance":{ + "title":"Insurance", + "description":"Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + }, + "xdm:note":{ + "title":"Note", + "description":"Extra information about the prescription that could not be conveyed by the other attributes.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/annotation" + } + }, + "xdm:renderedDosageInstruction":{ + "title":"Rendered Dosage Instruction", + "description":"The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", + "type":"string" + }, + "xdm:effectiveDosePeriod":{ + "title":"Effective Dose Period", + "description":"The period over which the medication is to be taken. Where there are multiple dosageInstruction lines (for example, tapering doses), this is the earliest date and the latest end date of the dosageInstructions.", + "$ref":"https://ns.fhir.org/datatypes/period" + }, + "xdm:dosageInstruction":{ + "title":"Dosage Instruction", + "description":"Specific instructions for how the medication is to be used by the patient.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/dosage" + } + }, + "xdm:dispenseRequest":{ + "title":"Dispense Request", + "description":"Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order).", + "type":"object", + "properties":{ + "xdm:initialFill":{ + "title":"Initial Fill", + "type":"object", + "properties":{ + "xdm:quantity":{ + "title":"quantity", + "description":"The amount or quantity to provide as part of the first dispense.", + "$ref":"https://ns.fhir.org/datatypes/simplequantity" + }, + "xdm:duration":{ + "title":"Duration", + "description":"The length of time that the first dispense is expected to last.", + "$ref":"https://ns.fhir.org/datatypes/duration" + } + } + }, + "xdm:dispenseInterval":{ + "title":"Dispense Interval", + "description":"The minimum period of time that must occur between dispenses of the medication.", + "$ref":"https://ns.fhir.org/datatypes/duration" + }, + "xdm:validityPeriod":{ + "title":"Validity Period", + "description":"This indicates the validity period of a prescription (stale dating the Prescription).", + "$ref":"https://ns.fhir.org/datatypes/period" + }, + "xdm:numberOfRepeatsAllowed":{ + "title":"Number Of Repeats Allowed", + "description":"Number of refills authorized", + "type":"integer", + "minimum":0 + }, + "xdm:quantity":{ + "title":"quantity", + "description":"The amount that is to be dispensed for one fill.", + "$ref":"https://ns.fhir.org/datatypes/simplequantity" + }, + "xdm:expectedSupplyDuration":{ + "title":"Expected Supply Duration", + "description":"Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.", + "$ref":"https://ns.fhir.org/datatypes/duration" + }, + "xdm:dispenser":{ + "title":"Dispenser", + "description":"Indicates the intended performing Organization that will dispense the medication as specified by the prescriber.", + "$ref":"https://ns.fhir.org/datatypes/reference" + }, + "xdm:dispenserInstruction":{ + "title":"Dispenser Instruction", + "description":"Provides additional information to the dispenser, for example, counselling to be provided to the patient.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/annotation" + } + }, + "xdm:doseAdministrationAid":{ + "title":"Dose Administration Aid", + "description":"Provides information about the type of adherence packaging to be supplied for the medication dispense.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + } + } + }, + "xdm:substitution":{ + "title":"Substitution", + "description":"Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen.", + "type":"object", + "properties":{ + "xdm:allowedBoolean":{ + "title":"Allowed Boolean", + "description":"True if the prescriber allows a different drug to be dispensed from what was prescribed.", + "type":"boolean" + }, + "xdm:allowedCodeableConcept":{ + "title":"Allowed Codeable Concept", + "description":"Code if the prescriber allows a different drug to be dispensed from what was prescribed.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + }, + "xdm:reason":{ + "title":"Reason", + "description":"Indicates the reason for the substitution, or why substitution must or must not be performed.", + "$ref":"https://ns.fhir.org/datatypes/codeableconcept" + } + } + }, + "xdm:eventHistory":{ + "title":"Event History", + "description":"Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.", + "type":"array", + "items":{ + "$ref":"https://ns.fhir.org/datatypes/reference" + } + } + } + } + } + } + }, + "allOf":[ + { + "$ref":"#/definitions/medicationRequest" + } + ], + "meta:status":"experimental" +} diff --git a/extensions/pathfactory/pathfactory-content-track.example.1.json b/extensions/pathfactory/pathfactory-content-track.example.1.json new file mode 100644 index 000000000..0967ef424 --- /dev/null +++ b/extensions/pathfactory/pathfactory-content-track.example.1.json @@ -0,0 +1 @@ +{} diff --git a/extensions/pathfactory/pathfactory-content-track.schema.json b/extensions/pathfactory/pathfactory-content-track.schema.json new file mode 100644 index 000000000..cc5a6cebf --- /dev/null +++ b/extensions/pathfactory/pathfactory-content-track.schema.json @@ -0,0 +1,236 @@ +{ + "meta:license": [ + "Copyright 2023 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/pathfactory-contenttrack", + "$schema": "http://json-schema.org/draft-06/schema#", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "title": "PathFactory Content Track Fieldgroup Details", + "type": "object", + "description": "This Field group captures and organizes metadata related to content tracks. It includes information such as track titles, content sequencing, and associated content assets. This schema is essential for managing how content is grouped, presented, and tracked within PathFactory, enabling personalized content journeys and providing insights into user engagement with specific content tracks.", + "definitions": { + "pfContentTrackFields": { + "properties": { + "pathfactory:contentTrack": { + "type": "object", + "title": "Pathfactory Content Track", + "description": "Pathfactory Content Track Field Object is used to get all the information related to Content Track which can be used for the analytics purpose and for content track recommendations", + "properties": { + "xdm:createdAtUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a Content Track Experience created in PathFactory platform", + "title": "Created Date (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:appID": { + "required": [], + "type": "string", + "description": "Defines 128 bit unique ID assigned to a Client's Organization in PathFactory platform", + "title": "App ID", + "meta:xdmType": "string" + }, + "xdm:isDeleted": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the Content Track Experience is deleted in PathFactory platform", + "title": "Deleted", + "meta:xdmType": "boolean" + }, + "xdm:experienceCustomURL": { + "required": [], + "type": "string", + "description": "Defines the Custom URL given to Content Track Experience in PathFactory platform", + "title": "Experience Custom URL", + "meta:xdmType": "string" + }, + "xdm:experienceID": { + "required": [], + "type": "integer", + "description": "Defines the unique ID assigned to a Content Track Experience in PathFactory platform", + "title": "Experience ID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:externalID": { + "required": [], + "type": "string", + "description": "Defines the Content Track Experience External ID in PathFactory platform", + "title": "Experience External ID", + "meta:xdmType": "string" + }, + "xdm:experienceName": { + "required": [], + "type": "string", + "description": "Defines the name given to Content Track Experience in PathFactory platform", + "title": "Experience Name", + "meta:xdmType": "string" + }, + "xdm:experienceType": { + "required": [], + "type": "string", + "description": "Defines the type of the Content Track Experience in PathFactory platform", + "title": "Experience Type (PathFactory Experience)", + "meta:xdmType": "string" + }, + "xdm:folderID": { + "required": [], + "type": "string", + "description": "Defines the folder ID under which Content Track Experience is created in PathFactory platform", + "title": "Folder ID (PathFactory)", + "meta:xdmType": "string" + }, + "xdm:isSidebarEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if sidebar has been enabled to show on Content Track Experience", + "title": "Is Sidebar Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isBottomBarEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if bottom bar has been enabled to show on Content Track Experience", + "title": "IS Bottom Bar Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isCardEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if card has been enabled to show on Content Track Experience", + "title": "Is Card Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isExitEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if exit promotor has been enabled to show on Content Track Experience", + "title": "Is Exit Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isInactivityEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if inactivity promotor has been enabled to show on Content Track Experience", + "title": "Is Inactivity Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isShareEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if share has been enabled", + "title": "Is Share Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isCaptureEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if form capture has been enabled", + "title": "Is Capture Enabled", + "meta:xdmType": "boolean" + }, + "xdm:experienceUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to a Content Track Experience", + "title": "Experience Unique ID", + "meta:xdmType": "string" + }, + "xdm:isCookieConsentEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if cookie consent has been enabled on Content Track Experience", + "title": "Is Cookie Consent Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isGDPRCookieConsentEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if GDPR cookie consent has been enabled on Content Track Experience", + "title": "Is GDPR Cookie Consent Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isHeaderEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if header section has been enabled to show on Content Track Experience", + "title": "Is Header Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isCookieMessageEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if a message displaying detailed information of cookies needs to be shown on a Content Track Experience", + "title": "Is Cookie Message Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isFlowEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the flow promoter has been enabled for a Content Track Experience. It is used to show the next button which displays the next content in the Content track", + "title": "Is Flow Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isSignpostEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the signpost has been enabled for a Content Track Experience. It is used to show previous and next button which displays the next and previous content in the Content track", + "title": "Is Signpost Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isTopicSidebarEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the topic sidebar has been enabled for a Content Track Experience. It is used to show Content track in sidebar", + "title": "is topic sidebar enabled", + "meta:xdmType": "boolean" + }, + "xdm:isLikeEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the like has been enabled to show like icon on Content Experience", + "title": "Is Like Enabled", + "meta:xdmType": "boolean" + }, + "xdm:isEndEnabled": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if an End promotor has been enabled to show on the last content of the Content Track Experience", + "title": "Is End Enabled", + "meta:xdmType": "boolean" + }, + "xdm:targetContentOrder": { + "required": [], + "type": "string", + "description": "Defines the order in which Content should be ordered on the Content Track Experience", + "title": "Target Content Order", + "meta:xdmType": "string" + }, + "xdm:updatedAtUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a Content Track Experience updated in PathFactory platform", + "title": "Updated Date (UTC)", + "meta:xdmType": "date-time" + } + }, + "meta:xdmType": "object" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/pfContentTrackFields" + } + ], + "meta:status": "experimental" +} diff --git a/extensions/pathfactory/pathfactory-content.example.1.json b/extensions/pathfactory/pathfactory-content.example.1.json new file mode 100644 index 000000000..0967ef424 --- /dev/null +++ b/extensions/pathfactory/pathfactory-content.example.1.json @@ -0,0 +1 @@ +{} diff --git a/extensions/pathfactory/pathfactory-content.schema.json b/extensions/pathfactory/pathfactory-content.schema.json new file mode 100644 index 000000000..84e6c2431 --- /dev/null +++ b/extensions/pathfactory/pathfactory-content.schema.json @@ -0,0 +1,144 @@ +{ + "meta:license": [ + "Copyright 2023 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/pathfactory-content", + "$schema": "http://json-schema.org/draft-06/schema#", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "title": "PathFactory Content Fieldgroup Details", + "type": "object", + "description": "This Field Group helps in organizing and storing key metadata for content assets. It includes details such as creation and update timestamps, titles, language, media type, and unique identifiers. This schema is essential for managing, categorizing, and delivering content effectively within PathFactory, ensuring each asset is easily identifiable and ready for personalized user experiences.", + "definitions": { + "pfContentFields": { + "properties": { + "pathfactory:content": { + "title": "Pathfactory Content", + "description": "Pathfactory Content Field Object is used to get all the information related to Content which can be used for the analytics purpose and for content recommendations", + "required": [ + "xdm:contentID", + "xdm:createdAtUTC", + "xdm:title", + "xdm:internalTitle" + ], + "type": "object", + "properties": { + "xdm:createdAtUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a Content created in PathFactory platform", + "title": "Created AT UTC", + "meta:xdmType": "date-time" + }, + "xdm:contentID": { + "required": [], + "type": "integer", + "description": "Defines the unique ID assigned to a Content", + "title": "Content ID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:updatedAtUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a Content/Asset updated in PathFactory platform", + "title": "Updated AT UTC", + "meta:xdmType": "date-time" + }, + "xdm:title": { + "required": [], + "type": "string", + "description": "Defines the title of the Content", + "title": "Content Title", + "meta:xdmType": "string" + }, + "xdm:internalTitle": { + "required": [], + "type": "string", + "description": "Defines the title given to the Content to be used within PathFactory platform", + "title": "Content Internal Title", + "meta:xdmType": "string" + }, + "xdm:slug": { + "required": [], + "type": "string", + "description": "Defines the Custom URL slug given to a Content in PathFactory platform", + "title": "Content URL Slug", + "meta:xdmType": "string" + }, + "xdm:language": { + "required": [], + "type": "string", + "description": "Defines the language in which the Content is displayed in PathFactory platform", + "title": "Language", + "meta:xdmType": "string" + }, + "xdm:description": { + "required": [], + "type": "string", + "description": "Defines the description about the Content", + "title": "Content Description", + "meta:xdmType": "string" + }, + "xdm:sourceURL": { + "required": [], + "type": "string", + "description": "Defines the source URL from where the Content was imported into the PathFactory platform", + "title": "Source URL", + "meta:xdmType": "string" + }, + "xdm:mediaType": { + "required": [], + "type": "string", + "description": "Defines the type of the Content Media (e.g pdf, mp3, png etc)", + "title": "Media Type", + "meta:xdmType": "string" + }, + "xdm:contentType": { + "required": [], + "type": "string", + "description": "Defines the list of content types assigned to the content. These tags will help the user in finding a specific type of content, such as Ebook or Case Study and can also be made public-facing for your target audiences", + "title": "Content Type", + "meta:xdmType": "string" + }, + "xdm:externalID": { + "required": [], + "type": "string", + "description": "Defines the Content External ID in PathFactory platform", + "title": "External ID", + "meta:xdmType": "string" + }, + "xdm:thumbnail": { + "required": [], + "type": "string", + "description": "Defines the string value of thumbnail for a Content", + "title": "Thumbnail", + "meta:xdmType": "string" + }, + "xdm:UUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to a Content", + "title": "Content UUID", + "meta:xdmType": "string" + } + }, + "meta:xdmType": "object" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/pfContentFields" + } + ], + "meta:status": "experimental" +} diff --git a/extensions/pathfactory/pathfactory-page-view.example.1.json b/extensions/pathfactory/pathfactory-page-view.example.1.json new file mode 100644 index 000000000..0967ef424 --- /dev/null +++ b/extensions/pathfactory/pathfactory-page-view.example.1.json @@ -0,0 +1 @@ +{} diff --git a/extensions/pathfactory/pathfactory-page-view.schema.json b/extensions/pathfactory/pathfactory-page-view.schema.json new file mode 100644 index 000000000..0a6cb5493 --- /dev/null +++ b/extensions/pathfactory/pathfactory-page-view.schema.json @@ -0,0 +1,652 @@ +{ + "meta:license": [ + "Copyright 2023 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/pathfactory-pageview", + "$schema": "http://json-schema.org/draft-06/schema#", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "title": "PathFactory Page Views Fieldgroup Details", + "type": "object", + "description": "This Field Group provides fields to capture and record detailed information about page views by visitors. It tracks every instance a visitor loads or reloads a page, providing crucial data for analyzing user engagement and content performance. The PathFactory Page Views Schema Field helps in understanding which pages are most frequently viewed, identifying popular content, and detecting patterns in visitor behavior. This data is instrumental in optimizing content delivery, personalizing visitor experiences, and driving strategic decisions based on real-time user interaction insights.", + "definitions": { + "pfPageViewFields": { + "properties": { + "pathfactory:pageview": { + "title": "Pathfactory Page View", + "description": "Pathfactory Page View Object is used to measure the total number of times a webpage is loaded, providing key insights into user engagement, content effectiveness, and website performance", + "type": "object", + "properties": { + "xdm:appID": { + "required": [], + "type": "string", + "description": "Defines 128 bit unique ID assigned to Client's Organization in PathFactory platform", + "title": "Organization UUID", + "meta:xdmType": "string" + }, + "xdm:pageViewID": { + "required": [], + "type": "string", + "description": "Defines the unique ID assigned to each Page View in PathFactory platform", + "title": "Page View ID", + "meta:xdmType": "string" + }, + "xdm:visitorID": { + "required": [], + "type": "string", + "description": "Defines the unique ID assigned to Visitor", + "title": "Visitor Identity", + "meta:xdmType": "string" + }, + "xdm:visitorUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to each visitor", + "title": "Visitor UUID", + "meta:xdmType": "string" + }, + "xdm:sessionID": { + "required": [], + "type": "string", + "description": "Defines a unique ID that a web server assigns to a user for the duration of the current session", + "title": "Session ID", + "meta:xdmType": "string" + }, + "xdm:sessionIndex": { + "required": [], + "type": "integer", + "description": "Defines the number of times the visitor started session on this page. e.g this page was visited 3rd time by the user in a new session.", + "title": "Session Index", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:pageViewIndex": { + "required": [], + "type": "integer", + "description": "Defines the order in which the visitor visited this page. e.g this page was the 2nd content that the user visited in this session.", + "title": "Page View Index", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:totalPageViews": { + "required": [], + "type": "integer", + "description": "Defines the total number of page views by the user", + "title": "Total Page Views", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:modifiedUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a page modified in PathFactory platform", + "title": "Modified UTC", + "meta:xdmType": "date-time" + }, + "xdm:createdAt": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a Page created in PathFactory platform", + "title": "Created At", + "meta:xdmType": "date-time" + }, + "xdm:startTime": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in general format, when user started visiting a Page in PathFactory platform", + "title": "Visit Date/Time", + "meta:xdmType": "date-time" + }, + "xdm:startTimeUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in UTC format, when user started visiting a Page in PathFactory platform", + "title": "Visit Date/Time (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:endTimeUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in UTC format, when user ended visiting a Page in PathFactory platform", + "title": "End Time UTC", + "meta:xdmType": "date-time" + }, + "xdm:engagedTimeInS": { + "required": [], + "type": "integer", + "description": "Defines the time in seconds for the duration the user was engaged with a Page", + "title": "Engaged Time in S", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:contentUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to Content", + "title": "Content UUID", + "meta:xdmType": "string" + }, + "xdm:experienceUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to Experience in PathFactory platform", + "title": "Experience UUID", + "meta:xdmType": "string" + }, + "xdm:contentID": { + "required": [], + "type": "integer", + "description": "Defines the unique ID assigned to Content", + "title": "Content ID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:experienceID": { + "required": [], + "type": "integer", + "description": "Defines the unique ID assigned to Experience in PathFactory platform", + "title": "Experience ID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:verticalPercentageScrolled": { + "required": [], + "type": "integer", + "description": "Defines that how much page visitor has scrolled veritically", + "title": "Scroll Depth", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:pageWidth": { + "required": [], + "type": "integer", + "description": "Defines the width of a page in pixels", + "title": "Page Width", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:pageHeight": { + "required": [], + "type": "integer", + "description": "Defines the height of a page in pixels", + "title": "Page Height", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:pageTitle": { + "required": [], + "type": "string", + "description": "Defines the title given to a page", + "title": "Page Title", + "meta:xdmType": "string" + }, + "xdm:pageURL": { + "required": [], + "type": "string", + "description": "Defines the URL of the page through which it can be accessed", + "title": "Page URL", + "meta:xdmType": "string" + }, + "xdm:queryString": { + "required": [], + "type": "string", + "description": "Defines the pre-defined custom query string appended at the end of the page URL, which are created on PathFactory platform", + "title": "Query String", + "meta:xdmType": "string" + }, + "xdm:pageURLquery": { + "required": [], + "type": "string", + "description": "Defines the actual query string appended at the end of the page URL, like searchValue, pageNumber, filterValues etc.", + "title": "Page URLquery", + "meta:xdmType": "string" + }, + "xdm:marketingMedium": { + "required": [], + "type": "string", + "description": "Marketing Medium is a UTM parameter field used by the marketer", + "title": "Marketing Medium", + "meta:xdmType": "string" + }, + "xdm:marketingSource": { + "required": [], + "type": "string", + "description": "Marketing Source is a UTM parameter field used by the marketer", + "title": "Marketing Source", + "meta:xdmType": "string" + }, + "xdm:marketingTerm": { + "required": [], + "type": "string", + "description": "Marketing Term is a UTM parameter field used by the marketer", + "title": "Marketing Term", + "meta:xdmType": "string" + }, + "xdm:marketingContent": { + "required": [], + "type": "string", + "description": "Marketing Content is a UTM parameter field used by the marketer", + "title": "Marketing Content", + "meta:xdmType": "string" + }, + "xdm:marketingCampaign": { + "required": [], + "type": "string", + "description": "Marketing Campaign is a UTM parameter field used by the marketer", + "title": "Marketing Campaign", + "meta:xdmType": "string" + }, + "xdm:pageReferrer": { + "required": [], + "type": "string", + "description": "Defines from where this page is referred to the user.", + "title": "Page Referrer", + "meta:xdmType": "string" + }, + "xdm:referrerMedium": { + "required": [], + "type": "string", + "description": "Defines how the user visited the first page in the session e.g. search, social, direct, email etc.", + "title": "Referrer Medium", + "meta:xdmType": "string" + }, + "xdm:referrerSource": { + "required": [], + "type": "string", + "description": "Defines the source that referred this page to the user. e.g. Google, Yahoo, LinkedIn etc.", + "title": "Referrer Source", + "meta:xdmType": "string" + }, + "xdm:referrerTerm": { + "required": [], + "type": "string", + "description": "Defines the term that was searched by the user to find this page.", + "title": "Referrer Term", + "meta:xdmType": "string" + }, + "xdm:ipAddress": { + "required": [], + "type": "string", + "description": "Defines the IP Address of the Visitor", + "title": "IP Address", + "meta:xdmType": "string" + }, + "xdm:browser": { + "required": [], + "type": "string", + "description": "Defines the browser used to visit the pages", + "title": "Browser", + "meta:xdmType": "string" + }, + "xdm:isSpiderOrRobot": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the session is generated by a robot or a crawler", + "title": "Spider/Robot (T/F)", + "meta:xdmType": "boolean" + }, + "xdm:os": { + "required": [], + "type": "string", + "description": "Defines the OS used while visiting the pages", + "title": "OS", + "meta:xdmType": "string" + }, + "xdm:deviceType": { + "required": [], + "type": "string", + "description": "Defines the Device used while visting the pages, i.e. Computer, mobile etc.", + "title": "Device Type", + "meta:xdmType": "string" + }, + "xdm:fromRecommendation": { + "required": [], + "type": "string", + "description": "Defines if this content was a part of PathFactory AI recommendations", + "title": "From Recommendation", + "meta:xdmType": "string" + }, + "xdm:recMdmGuide": { + "required": [], + "type": "string", + "description": "Defines if the content was clicked from PathFactory product called Guide.", + "title": "Rec Mdm Guide", + "meta:xdmType": "string" + }, + "xdm:recMdmConcierge": { + "required": [], + "type": "string", + "description": "Defines if the content was clicked from PathFactory product called Concierge.", + "title": "Rec Mdm Concierge", + "meta:xdmType": "string" + }, + "xdm:recSrcRecommended": { + "required": [], + "type": "string", + "description": "Defines if the content was clicked from 'Recommended for you' carousel", + "title": "Rec Src Recommended", + "meta:xdmType": "string" + }, + "xdm:recSrcTrending": { + "required": [], + "type": "string", + "description": "Defines if the content was clicked from 'Trending' carousel", + "title": "Rec Src Trending", + "meta:xdmType": "string" + }, + "xdm:referrerURL": { + "required": [], + "type": "string", + "description": "Defines the URL of a source which referred this page", + "title": "Referrer URL", + "meta:xdmType": "string" + }, + "xdm:ipISP": { + "required": [], + "type": "string", + "description": "Defines the IP address of Internet Service Provider used by Visitor", + "title": "IP ISP", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyDomain": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Domain name fetched from 3rd party 6sense tool if available", + "title": "Company Domain (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyRegion": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Region fetched from 3rd party 6sense tool if available", + "title": "Company Region (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyCountry": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Country fetched from 3rd party 6sense tool if available", + "title": "Company Country (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyCountryIsoCode": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Country ISO Code fetched from 3rd party 6sense tool if available", + "title": "Company Country ISO (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyState": { + "required": [], + "type": "string", + "description": "Defines visitor's Company State fetched from 3rd party 6sense tool if available", + "title": "Company State (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyCity": { + "required": [], + "type": "string", + "description": "Defines visitor's Company City fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company City", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyStreetAddress": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Address fetched from 3rd party 6sense tool if available", + "title": "Company Address (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyPostalCode": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Postal Code fetched from 3rd party 6sense tool if available", + "title": "Company Postal Code (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyPhone": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Phone Number fetched from 3rd party 6sense tool if available", + "title": "Company Phone (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyIndustry": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Industry fetched from 3rd party 6sense tool if available", + "title": "Company Industry (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyEmployeeRange": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Employee Range (i.e 1-200, 1-10000 etc.) fetched from 3rd party 6sense tool if available", + "title": "Company Employee Range (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyRevenueRange": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Revenue Range fetched from 3rd party 6sense tool if available", + "title": "Company Revenue Range (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyEmployeeCount": { + "required": [], + "type": "integer", + "description": "Defines visitor's company's Employee Count fetched from 3rd party 6sense tool if available", + "title": "Company Employee Count (6sense)", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:sixsenseCompanyAnnualRevenue": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Annual Business Revenue fetched from 3rd party 6sense tool if available", + "title": "Company Annual Revenue (6Sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyTitleLevel": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Title Level fetched from 3rd party 6sense tool if available", + "title": "Company Title Level (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyTitleFunction": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Title Function fetched from 3rd party 6sense tool if available", + "title": "Company Title Function (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanySICCode": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Standard Industrial Classification Code fetched from 3rd party 6sense tool if available", + "title": "Company SIC Code (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanySICDescription": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Standard Industrial Classification Code Description fetched from 3rd party 6sense tool if available", + "title": "Company SIC Description (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyNAICSCode": { + "required": [], + "type": "string", + "description": "Defines visitor's company's North American Industry Classification System Code fetched from 3rd party 6sense tool if available", + "title": "Company NAICS Code (6sense)", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyNAICSDescription": { + "required": [], + "type": "string", + "description": "Defines visitor's company's North American Industry Classification System Description fetched from 3rd party 6sense tool if available", + "title": "Company NAICS Description (6sense)", + "meta:xdmType": "string" + }, + "xdm:isSixsenseCompanyBlacklisted": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if visitor's company is blacklisted or not using 3rd party tool - 6sense", + "title": "Company Blacklisted? (6sense ; T/F)", + "meta:xdmType": "boolean" + }, + "xdm:sixsenseConfidence": { + "required": [], + "type": "string", + "description": "Defines the score of Company Confidence Level from 3rd party tool - 6sense, which is the percentage of all possible samples expected to include the true population parameter.", + "title": "Company Confidence Level (6sense)", + "meta:xdmType": "string" + }, + "xdm:experienceType": { + "required": [], + "type": "string", + "description": "Defines the type of the Experience of the page in PathFactory platform", + "title": "Experience Type", + "meta:xdmType": "string" + }, + "xdm:demandbaseSID": { + "required": [], + "type": "integer", + "description": "Defines the unique Security IDentifier assigned to a company or a group in Demandbase tool", + "title": "Demandbase SID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:demandbaseCompanyName": { + "required": [], + "type": "string", + "description": "Defines visitor's Company name fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Company Name", + "meta:xdmType": "string" + }, + "xdm:demandbaseAnnualSales": { + "required": [], + "type": "integer", + "description": "Defines visitor's company's Annual Business Sales fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Annual Sales", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:demandbaseEmployeeCount": { + "required": [], + "type": "integer", + "description": "Defines visitor's company's Employee Count fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Employee Count", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:demandbaseIndustry": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Industry fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Industry", + "meta:xdmType": "string" + }, + "xdm:demandbaseWebSite": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Website fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Website", + "meta:xdmType": "string" + }, + "xdm:unifiedEngagementScore": { + "required": [], + "type": "integer", + "description": "Defines the unified total score of a visitor session", + "title": "PF Engagement Score, Unified", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:engagementScore": { + "required": [], + "type": "integer", + "description": "Defines the total score of a visitor session", + "title": "Engagement Score", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:experienceCampaignID": { + "required": [], + "type": "string", + "description": "Defines the unique campaign ID to which an Experience belongs to in PathFactory platform", + "title": "Experience Campaign ID", + "meta:xdmType": "string" + }, + "xdm:campaignID": { + "required": [], + "type": "string", + "description": "Defines the unique campaign ID to which a Content belongs to in PathFactory platform", + "title": "Campaign ID", + "meta:xdmType": "string" + }, + "xdm:websiteExperienceUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to a Website Experience in PathFactory platform", + "title": "Website Experience UUID", + "meta:xdmType": "string" + }, + "xdm:ip2ProxyIsproxy": { + "required": [], + "type": "string", + "description": "Defines if the request is coming from the proxy server using 3rd party tool called - IP2Location", + "title": "Ip 2 Proxy Isproxy", + "meta:xdmType": "string" + }, + "xdm:normalizedURL": { + "required": [], + "type": "string", + "description": "Defines Normalized URL which is generally used to determine if two syntactically different URIs may be equivalent", + "title": "Normalized URL", + "meta:xdmType": "string" + }, + "xdm:identityECID": { + "required": [], + "type": "string", + "description": "Defines the unique ECID assigned to a Visitor", + "title": "Identity ECID", + "meta:xdmType": "string" + } + }, + "meta:xdmType": "object" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/pfPageViewFields" + } + ], + "meta:status": "experimental" +} diff --git a/extensions/pathfactory/pathfactory-session.example.1.json b/extensions/pathfactory/pathfactory-session.example.1.json new file mode 100644 index 000000000..0967ef424 --- /dev/null +++ b/extensions/pathfactory/pathfactory-session.example.1.json @@ -0,0 +1 @@ +{} diff --git a/extensions/pathfactory/pathfactory-session.schema.json b/extensions/pathfactory/pathfactory-session.schema.json new file mode 100644 index 000000000..ad4a338e0 --- /dev/null +++ b/extensions/pathfactory/pathfactory-session.schema.json @@ -0,0 +1,578 @@ +{ + "meta:license": [ + "Copyright 2023 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/pathfactory-session", + "$schema": "http://json-schema.org/draft-06/schema#", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "title": "PathFactory Session Fieldgroup Details", + "type": "object", + "description": "This Field Group is designed to capture and store detailed information about individual user sessions. A session represents a series of interactions a visitor has with the platform within a specific time frame. The PathFactory Session Schema Field Group records data such as session duration, the sequence of pages viewed, actions taken, and engagement levels. This information is crucial for understanding the context of user behavior, analyzing how visitors navigate through content, and identifying opportunities for enhancing the user experience. By leveraging this data, PathFactory can deliver more personalized content and improve overall session quality, contributing to more effective engagement strategies.", + "definitions": { + "pfSessionFields": { + "properties": { + "pathfactory:session": { + "title": "Pathfactory Session", + "description": "Pathfactory Session Object is used to get all the information related to User Session which can be used to break out users into groups based on certain characteristics of their sessions spent using PathFactory product", + "type": "object", + "properties": { + "xdm:sessionID": { + "required": [], + "type": "string", + "description": "Defines a unique ID that a web server assigns to a user for the duration of the current session", + "title": "Session ID", + "meta:xdmType": "string" + }, + "xdm:modifiedUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format for a session modified in PathFactory platform", + "title": "Modified UTC", + "meta:xdmType": "date-time" + }, + "xdm:averagePercentageScrolled": { + "required": [], + "type": "number", + "description": "Defines the how much visitor has scrolled the page on avarage veritically", + "title": "Average Percentage Scrolled", + "meta:xdmType": "number" + }, + "xdm:averageViewTimePerAsset": { + "required": [], + "type": "number", + "description": "Defines the average time the visitor has spent on each asset", + "title": "Average View Time Per Asset", + "meta:xdmType": "number" + }, + "xdm:captureModalShownCount": { + "required": [], + "type": "integer", + "description": "Defines the number of forms show in a Modal", + "title": "Capture Modal Shown Count", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:captures": { + "required": [], + "type": "integer", + "description": "Defines the total number of times a form was filled", + "title": "Captures", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:city": { + "required": [], + "type": "string", + "description": "Defines the City of a visitor from where user is trying to access the page", + "title": "City", + "meta:xdmType": "string" + }, + "xdm:clicks": { + "required": [], + "type": "integer", + "description": "Defines the Number of clicks by a visitor on the page of PathFactory platform", + "title": "Clicks", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:companyName": { + "required": [], + "type": "string", + "description": "Defines the company of a visitor from where user is trying to access the page", + "title": "Company Name", + "meta:xdmType": "string" + }, + "xdm:country": { + "required": [], + "type": "string", + "description": "Defines the Country of a visitor from where user is trying to access the page", + "title": "Country", + "meta:xdmType": "string" + }, + "xdm:dataSource": { + "required": [], + "type": "string", + "description": "Data Source", + "title": "Data Source", + "meta:xdmType": "string" + }, + "xdm:demandbaseAnnualSales": { + "required": [], + "type": "integer", + "description": "Defines visitor's company's Annual Business Sales fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Annual Sales", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:demandbaseCompanyName": { + "required": [], + "type": "string", + "description": "Defines visitor's Company name fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Company Name", + "meta:xdmType": "string" + }, + "xdm:demandbaseEmployeeCount": { + "required": [], + "type": "integer", + "description": "Defines visitor's company's Employee Count fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Employee Count", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:demandbaseIndustry": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Industry fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Industry", + "meta:xdmType": "string" + }, + "xdm:demandbaseSID": { + "required": [], + "type": "integer", + "description": "Defines the unique Security IDentifier assigned to a company or a group in Demandbase tool", + "title": "Demandbase SID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:demandbaseWebSite": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Website fetched from 3rd party Demandbase tool if available", + "title": "Demandbase Website", + "meta:xdmType": "string" + }, + "xdm:deviceType": { + "required": [], + "type": "string", + "description": "Defines the Device used while visting the pages, i.e. Computer, mobile etc.", + "title": "Device Type", + "meta:xdmType": "string" + }, + "xdm:domain": { + "required": [], + "type": "string", + "description": "Defines visitor's Domain name", + "title": "Domain", + "meta:xdmType": "string" + }, + "xdm:emailAddress": { + "required": [], + "type": "string", + "description": "Defines the email address of a Visitor", + "title": "Email Address", + "meta:xdmType": "string" + }, + "xdm:emailDomain": { + "required": [], + "type": "string", + "description": "Defines the email domain of a Visitor", + "title": "Email Domain", + "meta:xdmType": "string" + }, + "xdm:endTimeUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in UTC format, when user ended the session", + "title": "End Time (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:endTime": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in general format, when user ended the session", + "title": "End Time", + "meta:xdmType": "date-time" + }, + "xdm:engagementScore": { + "required": [], + "type": "integer", + "description": "Defines the total score of a visitor session", + "title": "Engagement Score", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:engagementTime": { + "required": [], + "type": "integer", + "description": "Defines the total time spent on a current session", + "title": "Engagement Time", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:experienceExternalID": { + "required": [], + "type": "string", + "description": "Defines the Content Track Experience External ID in PathFactory platform", + "title": "Experience External ID", + "meta:xdmType": "string" + }, + "xdm:experienceID": { + "required": [], + "type": "integer", + "description": "Defines the unique ID assigned to Content Track Experience in PathFactory platform", + "title": "Experience ID", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:experienceName": { + "required": [], + "type": "string", + "description": "Defines the name given to Experience in PathFactory platform", + "title": "Experience Name", + "meta:xdmType": "string" + }, + "xdm:incrementalEngagementTime": { + "required": [], + "type": "integer", + "description": "Defines the additional time a user spends engaging with content beyond an initial baseline or expected level", + "title": "Incremental Engagement Time", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:ip": { + "required": [], + "type": "string", + "description": "Defines the IP Address of the Visitor", + "title": "IP", + "meta:xdmType": "string" + }, + "xdm:ip2ProxyIsproxy": { + "required": [], + "type": "string", + "description": "Defines if the request is coming from the proxy server using 3rd party tool called - IP2Location", + "title": "IP 2 Proxy Is Proxy", + "meta:xdmType": "string" + }, + "xdm:isp": { + "required": [], + "type": "string", + "description": "Defines the Internet Service Provider's name of the Visitor", + "title": "ISP", + "meta:xdmType": "string" + }, + "xdm:likes": { + "required": [], + "type": "string", + "description": "Defines number of likes page has received", + "title": "Likes", + "meta:xdmType": "string" + }, + "xdm:os": { + "required": [], + "type": "string", + "description": "Defines the OS used while visiting the pages", + "title": "OS", + "meta:xdmType": "string" + }, + "xdm:queryString": { + "required": [], + "type": "string", + "description": "Defines the pre-defined custom query string appended at the end of the page URL, which are created on PathFactory platform", + "title": "Query String", + "meta:xdmType": "string" + }, + "xdm:referrerURL": { + "required": [], + "type": "string", + "description": "Defines the URL of a source which referred this page", + "title": "Referrer URL", + "meta:xdmType": "string" + }, + "xdm:region": { + "required": [], + "type": "string", + "description": "Defines the Region from where session is initiated", + "title": "Region", + "meta:xdmType": "string" + }, + "xdm:referrerMedium": { + "required": [], + "type": "string", + "description": "Defines how the user visited the first page in the session e.g. search, social, direct, email etc.", + "title": "Referrer Medium", + "meta:xdmType": "string" + }, + "xdm:referrerSource": { + "required": [], + "type": "string", + "description": "Defines the source that referred this page to the user. e.g. Google, Yahoo, LinkedIn etc.", + "title": "Referrer Source", + "meta:xdmType": "string" + }, + "xdm:referrerTerm": { + "required": [], + "type": "string", + "description": "Defines the term that was searched by the user to find this page.", + "title": "Referrer Term", + "meta:xdmType": "string" + }, + "xdm:shares": { + "required": [], + "type": "string", + "description": "Defines the total number of page shares", + "title": "Shares", + "meta:xdmType": "string" + }, + "xdm:startTimeUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in UTC format, when user started the session", + "title": "Start Time (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:startTime": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Time in general format, when user started the session", + "title": "Start Time", + "meta:xdmType": "date-time" + }, + "xdm:sixsenseCompanyCountryISOCode": { + "required": [], + "type": "string", + "description": "Defines Country ISO Code of visitor's Company and it is fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Country ISO Code", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyEmployeeCount": { + "required": [], + "type": "integer", + "description": "Defines visitor's company's Employee Count fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Employee Count", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:sixsenseCompanyEmployeeRange": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Employee Range (i.e 1-200, 1-10000 etc.) fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Employee Range", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyIndustry": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Industry fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Industry", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyNAICSCode": { + "required": [], + "type": "string", + "description": "Defines visitor's company's North American Industry Classification System Code fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Naicscode", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyNAICSDescription": { + "required": [], + "type": "string", + "description": "Defines visitor's company's North American Industry Classification System Description fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Naicsdescription", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyPhone": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Phone Number fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Phone", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyPostalCode": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Postal Code fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Postal Code", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyRevenueRange": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Revenue Range fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Revenue Range", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanySICCode": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Standard Industrial Classification Code fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Siccode", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanySICDescription": { + "required": [], + "type": "string", + "description": "Defines visitor's company's Standard Industrial Classification Code Description fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Sicdescription", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyState": { + "required": [], + "type": "string", + "description": "Defines visitor's Company State fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company State", + "meta:xdmType": "string" + }, + "xdm:sixsenseCompanyStreetAddress": { + "required": [], + "type": "string", + "description": "Defines visitor's Company Address fetched from 3rd party 6sense tool if available", + "title": "Sixsense Company Street Address", + "meta:xdmType": "string" + }, + "xdm:isSpiderOrRobot": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the session is generated by a robot or a crawler", + "title": "Spider OR Robot", + "meta:xdmType": "boolean" + }, + "xdm:totalAssetViews": { + "required": [], + "type": "integer", + "description": "Defines the total number of asset views in a session", + "title": "Total Asset Views", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:uniqueViews": { + "required": [], + "type": "integer", + "description": "Defines the total number of unique views in a session", + "title": "Unique Views", + "meta:xdmType": "int", + "minimum": -2147483648, + "maximum": 2147483647 + }, + "xdm:userAgent": { + "required": [], + "type": "string", + "description": "User Agent request header is a characteristic string that lets servers and network peers identify the application.", + "title": "User Agent", + "meta:xdmType": "string" + }, + "xdm:marketingCampaign": { + "required": [], + "type": "string", + "description": "Marketing Campaign is a UTM parameter field used by the marketer", + "title": "Marketing Campaign", + "meta:xdmType": "string" + }, + "xdm:marketingContent": { + "required": [], + "type": "string", + "description": "Marketing Content is a UTM parameter field used by the marketer", + "title": "Marketing Content", + "meta:xdmType": "string" + }, + "xdm:marketingMedium": { + "required": [], + "type": "string", + "description": "Marketing Medium is a UTM parameter field used by the marketer", + "title": "Marketing Medium", + "meta:xdmType": "string" + }, + "xdm:marketingSource": { + "required": [], + "type": "string", + "description": "Marketing Source is a UTM parameter field used by the marketer", + "title": "Marketing Source", + "meta:xdmType": "string" + }, + "xdm:marketingTerm": { + "required": [], + "type": "string", + "description": "Marketing Term is a UTM parameter field used by the marketer", + "title": "Marketing Term", + "meta:xdmType": "string" + }, + "xdm:unifiedExperienceUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to Unified Experience in PathFactory platform", + "title": "Unified Experience UUID", + "meta:xdmType": "string" + }, + "xdm:experienceUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to Experience in PathFactory platform", + "title": "Experience UUID", + "meta:xdmType": "string" + }, + "xdm:webExpID": { + "required": [], + "type": "string", + "description": "Defines the unique web ID assigned to Experience in PathFactory platform", + "title": "Web Exp ID", + "meta:xdmType": "string" + }, + "xdm:browser": { + "required": [], + "type": "string", + "description": "Defines the browser used to visit the pages during the current session", + "title": "Browser", + "meta:xdmType": "string" + }, + "xdm:experienceType": { + "required": [], + "type": "string", + "description": "Defines the type of the Experience of the page in PathFactory platform", + "title": "Experience Type", + "meta:xdmType": "string" + }, + "xdm:visitorID": { + "required": [], + "type": "string", + "description": "Defines the unique ID assigned to Visitor", + "title": "Visitor Identity", + "meta:xdmType": "string" + }, + "xdm:visitorUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to each visitor upon visiting any Page", + "title": "Visitor UUID", + "meta:xdmType": "string" + }, + "xdm:identityECID": { + "required": [], + "type": "string", + "description": "Defines the unique ECID assigned to a Visitor", + "title": "Identity ECID", + "meta:xdmType": "string" + } + }, + "meta:xdmType": "object" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/pfSessionFields" + } + ], + "meta:status": "experimental" +} diff --git a/extensions/pathfactory/pathfactory-visitor.example.1.json b/extensions/pathfactory/pathfactory-visitor.example.1.json new file mode 100644 index 000000000..0967ef424 --- /dev/null +++ b/extensions/pathfactory/pathfactory-visitor.example.1.json @@ -0,0 +1 @@ +{} diff --git a/extensions/pathfactory/pathfactory-visitor.schema.json b/extensions/pathfactory/pathfactory-visitor.schema.json new file mode 100644 index 000000000..39def79e2 --- /dev/null +++ b/extensions/pathfactory/pathfactory-visitor.schema.json @@ -0,0 +1,130 @@ +{ + "meta:license": [ + "Copyright 2023 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/pathfactory-visitor", + "$schema": "http://json-schema.org/draft-06/schema#", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "title": "PathFactory Visitor Fieldgroup Details", + "type": "object", + "description": "This Field Group represents specific attributes or data points within the visitor schema that PathFactory uses to understand and categorize user interactions. These schema fields are essential for tailoring content experiences, enabling personalized pathways, and capturing insights into visitor behavior. The data collected through these fields helps in building comprehensive visitor profiles, facilitating targeted marketing efforts, and enhancing the overall user journey on the platform.", + "definitions": { + "pfVisitorFields": { + "properties": { + "pathfactory:visitor": { + "title": "Pathfactory Visitor", + "description": "Pathfactory Visitor Object is used to get all the information related to Visitor which can be used for the analytics purpose and for more personalised user exeprience", + "type": "object", + "properties": { + "xdm:createdAtUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format when a new Visitor is created in PathFactory platform", + "title": "Created At (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:emailDomain": { + "required": [], + "type": "string", + "description": "Defines the email domain of a Visitor", + "title": "Email Domain", + "meta:xdmType": "string" + }, + "xdm:email": { + "required": [], + "type": "string", + "description": "Defines the email address of a Visitor", + "title": "Email", + "meta:xdmType": "string" + }, + "xdm:visitorECID": { + "required": [], + "type": "string", + "description": "Defines the Adobe ECID of a Visitor", + "title": "Adobe ECID", + "meta:xdmType": "string" + }, + "xdm:lastVisitTimeUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format when Visitor last visited any page in PathFactory platform", + "title": "Last Visit Time (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:visitorID": { + "required": [], + "type": "string", + "description": "Defines the unique ID assigned to a Visitor", + "title": "Visitor ID", + "meta:xdmType": "string" + }, + "xdm:visitorUUID": { + "required": [], + "type": "string", + "description": "Defines the 128 bit unique ID assigned to a Visitor", + "title": "Visitor UUID", + "meta:xdmType": "string" + }, + "xdm:visitorIdentity": { + "required": [], + "type": "string", + "description": "Defines the unique Identity assigned to a Visitor in PathFactory platform", + "title": "Visitor Identity", + "meta:xdmType": "string" + }, + "xdm:isKnown": { + "required": [], + "type": "boolean", + "description": "Boolean variable to check if the Visitor is already known to the PathFactory platform or not", + "title": "Is Known", + "meta:xdmType": "boolean" + }, + "xdm:knownFrom": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in general format since when the Visitor is known to the PathFactory platform", + "title": "Known From", + "meta:xdmType": "date-time" + }, + "xdm:firstVisitTimeUTC": { + "required": [], + "format": "date-time", + "type": "string", + "description": "Defines the Date in UTC format when the Visitor first visited any page in PathFactory platform", + "title": "First Visit Time (UTC)", + "meta:xdmType": "date-time" + }, + "xdm:identityECID": { + "required": [], + "type": "string", + "description": "Defines the unique ECID assigned to a Visitor", + "title": "Identity ECID", + "meta:xdmType": "string" + } + }, + "meta:xdmType": "object", + "required": [ + "xdm:visitorID", + "xdm:visitorUUID", + "xdm:visitorIdentity", + "xdm:isKnown" + ] + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/pfVisitorFields" + } + ], + "meta:status": "experimental" +}