FHIR IG Statistics: StructureDefinition/profile-parameters-daily-totals-details-IN

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

No narrative content found in resource

Source

{
  "resourceType": "StructureDefinition",
  "id": "profile-parameters-daily-totals-details-IN",
  "url": "http://pharmacyeclaims.ca/FHIR/v1.0/StructureDefinition/profile-parameters-daily-totals-details-IN",
  "name": "DailyTotalsDetailsParametersIN",
  "title": "DailyTotals and Details Parameters IN",
  "status": "draft",
  "description": "DailyTotalsParametersIN is used to query an adjudicator to retrieve daily totals over a period of time",
  "purpose": "Usedis used to query an adjudicator to retrieve daily totals over a period of time.  Also used to query details",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Parameters",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Parameters",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Parameters.parameter",
        "path": "Parameters.parameter",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "id"
            }
          ],
          "rules": "open"
        },
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter.id",
        "path": "Parameters.parameter.id",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter.name",
        "path": "Parameters.parameter.name",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter.value[x]",
        "path": "Parameters.parameter.value[x]",
        "comment": "Usage Note:  Limited to 6N\r\nCPHA:  Trace Number",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:TraceNumber",
        "path": "Parameters.parameter",
        "sliceName": "TraceNumber",
        "comment": "Usage Note:  Identifier assigned to this transaction; limited to 6N for backward compatibility.  Note; we have a message identifier which is unrestricted in size\r\nCPHA Map: B.23.03 Trace Number  6N",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:TraceNumber.name",
        "path": "Parameters.parameter.name",
        "fixedString": "TraceNumber"
      },
      {
        "id": "Parameters.parameter:TraceNumber.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "Parameters.parameter:TraceNumber.value[x].system",
        "path": "Parameters.parameter.value[x].system",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:TraceNumber.value[x].value",
        "path": "Parameters.parameter.value[x].value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:StartDate",
        "path": "Parameters.parameter",
        "sliceName": "StartDate",
        "comment": "Usage Note:  Specifies the start date of the desired result set and is therefore mandatory\r\nCPHA Map:  F.91.03 Beginning of Record",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:StartDate.name",
        "path": "Parameters.parameter.name",
        "fixedString": "StartDate"
      },
      {
        "id": "Parameters.parameter:StartDate.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Parameters.parameter:EndDate",
        "path": "Parameters.parameter",
        "sliceName": "EndDate",
        "comment": "Usage Note:   Specifies the end date of the result set; mus t be included when known when adjudicator natively supports FHIR\r\nCPHA Map:  New; reject if not same as start date; configurable by adjudicator",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:EndDate.name",
        "path": "Parameters.parameter.name",
        "fixedString": "EndDate"
      },
      {
        "id": "Parameters.parameter:EndDate.value[x]",
        "path": "Parameters.parameter.value[x]",
        "min": 1,
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "Parameters.parameter:ResultsRule",
        "path": "Parameters.parameter",
        "sliceName": "ResultsRule",
        "comment": "Usage Rule:   This specifies the type of response desired.  Code= Include/Exclude/All\r\nAll=Return everything (Carrier/Group list MUST be blank)\r\nInclude=Return only carrier/groups that are specifed in the list\r\nExclude=Return everything EXCEPT carrier/groups that are specified in the list\r\nCPHA Mapping:  Not in CPHA; Adjudicators map all to return everything; else reject",
        "min": 1,
        "max": "1",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:ResultsRule.name",
        "path": "Parameters.parameter.name",
        "fixedString": "ResultsRule"
      },
      {
        "id": "Parameters.parameter:ResultsRule.value[x]",
        "path": "Parameters.parameter.value[x]",
        "min": 1,
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "Parameters.parameter:CarrierGroup",
        "path": "Parameters.parameter",
        "sliceName": "CarrierGroup",
        "comment": "Usage Note:  Specifies the carrier and, if present their associated groups that are to be included or excluded from the desired result set.    The provider may utilize this field to identify a particular plan within an IIN to obtain more precise summaries, if payments are issued by carrier ID, or to obtain more concise detailed records from adjudicators who segregate accounts by carrier ID.\r\nCPHA Map:   C.30.03 Carrier ID and the part C.31.03 Group Number or Code.",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:CarrierGroup.name",
        "path": "Parameters.parameter.name",
        "fixedString": "Carrier"
      },
      {
        "id": "Parameters.parameter:CarrierGroup.value[x]",
        "path": "Parameters.parameter.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:CarrierGroup.part",
        "path": "Parameters.parameter.part",
        "label": "Group",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "name"
            }
          ],
          "rules": "open"
        },
        "comment": "Usage Note:   A list of groups under the carrier that are to be included or excluded from the result set (refer to result rule)\r\nCPHA Map: C.31.03 Group Number or Code\r\n\r\nOnly one level of nested parameters is allowed.",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:CarrierGroup.part.name",
        "path": "Parameters.parameter.part.name",
        "fixedString": "Group",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:CarrierGroup.part.value[x]",
        "path": "Parameters.parameter.part.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:AdjudicatorID",
        "path": "Parameters.parameter",
        "sliceName": "AdjudicatorID",
        "comment": "Usage Note:  This is the destination adjudicator, that is identifiable via the MH.destination.   This is a codified version or string as assigned at time of implementation.\r\nCPHA Map A.01.03 IIN",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:AdjudicatorID.name",
        "path": "Parameters.parameter.name",
        "fixedString": "AdjudicatorID"
      },
      {
        "id": "Parameters.parameter:AdjudicatorID.value[x]",
        "path": "Parameters.parameter.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "Parameters.parameter:BeginningOfRecord",
        "path": "Parameters.parameter",
        "sliceName": "BeginningOfRecord",
        "comment": "Usage Rule:   This is only to be used for backward compatibility to the CPHA query request\r\nCPHA Map:  Beginning of Record F.91.03",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:BeginningOfRecord.name",
        "path": "Parameters.parameter.name",
        "fixedString": "BeginningOfRecord"
      },
      {
        "id": "Parameters.parameter:BeginningOfRecord.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "positiveInt"
          }
        ]
      },
      {
        "id": "Parameters.parameter:EndOfRecord",
        "path": "Parameters.parameter",
        "sliceName": "EndOfRecord",
        "comment": "Usage Rule:   This is only to be used for backward compatibility to the CPHA query request.   This will be deprecated over time but will not be required when both sender and receiver is using FHIR as there is no longer a restriction to 14 records.\r\nCPHA Map:   End of Record F.92.03",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:EndOfRecord.name",
        "path": "Parameters.parameter.name",
        "fixedString": "EndOfRecord",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:EndOfRecord.value[x]",
        "path": "Parameters.parameter.value[x]",
        "type": [
          {
            "code": "positiveInt"
          }
        ]
      },
      {
        "id": "Parameters.parameter:14RecordRestriction",
        "path": "Parameters.parameter",
        "sliceName": "14RecordRestriction",
        "comment": "Usage Note:   Value must = \"true\" to indicate that the sending system can only support 14 records being returned.  This will be used when a CPHA query is being mapped to a FHIR query which may happen during the MVP stage.   When the adjudicator receives this,  the query results are restricted to 14 and the FHIR paging is used to convey subsquent records.\r\nCPHA Map:  None",
        "mustSupport": true
      },
      {
        "id": "Parameters.parameter:14RecordRestriction.name",
        "path": "Parameters.parameter.name",
        "fixedString": "14RecordRestriction"
      },
      {
        "id": "Parameters.parameter:14RecordRestriction.value[x]",
        "path": "Parameters.parameter.value[x]",
        "comment": "Usage Note:  Set value = true to indicate the 14 record restriction",
        "type": [
          {
            "code": "boolean"
          }
        ]
      }
    ]
  }
}