Definition.json

Logical Model Definition

{
  "resourceType": "StructureDefinition",
  "id": "Definition",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">to do</div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Definition",
  "name": "Definition",
  "display": "definition",
  "status": "draft",
  "publisher": "Health Level Seven International fhir",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2016-08-11T17:02:54+10:00",
  "description": "Logical Model: A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
  "fhirVersion": "1.6.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/w5",
      "name": "W5 Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "snapshot": {
    "element": [
      {
        "id": "Definition",
        "path": "Definition",
        "short": "Definition Pattern",
        "definition": "A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.",
        "min": 0,
        "max": "*",
        "mapping": [
          {
            "identity": "rim",
            "map": "Act[moodCode<=DEFN]"
          }
        ]
      },
      {
        "id": "Definition.identifier",
        "path": "Definition.identifier",
        "short": "Business Identifer for definition/protocol",
        "definition": "Identifiers assigned to this request by the requester, performer and other systems.",
        "requirements": "Allows identification of the definition as it is known by various participating systems and in a way that remains consistent across servers.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".identifier"
          },
          {
            "identity": "w5",
            "map": "id"
          }
        ]
      },
      {
        "id": "Definition.definition",
        "path": "Definition.definition",
        "short": "Instantiates protocol or definition",
        "definition": "A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this definition.",
        "comments": "[The allowed reference resources may be adjusted as appropriate for the request resource].",
        "requirements": "Protocols and order sets may be refinements of more generic protocols and order sets.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Definition"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=DEFN].target"
          }
        ]
      },
      {
        "id": "Definition.parent",
        "path": "Definition.parent",
        "short": "Part of referenced definition",
        "definition": "A larger definition of which this particular definition is a component or step.",
        "comments": "[The allowed reference resources may be adjusted as appropriate for the event resource].",
        "requirements": "E.g. Drug administration as part of a procedure, procedure as part of observation, etc.",
        "alias": [
          "container"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Definition"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship[typeCode=COMP].source[moodCode=DEFN]"
          }
        ]
      },
      {
        "id": "Definition.replaces",
        "path": "Definition.replaces",
        "short": "Request(s) replaced by this request",
        "definition": "Completed or terminated request(s) whose function is taken by this new request.",
        "requirements": "As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.",
        "alias": [
          "supersedes",
          "prior",
          "renewed order"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Definition"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=RPLC].target"
          }
        ]
      },
      {
        "id": "Definition.status",
        "path": "Definition.status",
        "short": "draft | active | withdrawn",
        "definition": "The current state of the definition.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "strength": "required",
          "description": "Codes identifying the stage lifecycle stage of a definition",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/definition-status"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".status"
          },
          {
            "identity": "w5",
            "map": "status"
          }
        ]
      },
      {
        "id": "Definition.subject[x]",
        "path": "Definition.subject[x]",
        "short": "Type of individual the defined service is for",
        "definition": "A code or group definition that describes the intended subject of instantiations of this definition.",
        "requirements": "Many protocols, order sets and guidelines are inted for use only with specific types of patients or subjects.",
        "alias": [
          "patient"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Group"
          }
        ],
        "isSummary": true,
        "binding": {
          "strength": "example",
          "description": "Codes identifying the type of subject intended to be the recpient or focus of the defined action.  These should ideally be consistent across definition resources."
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=SBJ].role"
          },
          {
            "identity": "w5",
            "map": "who.focus"
          }
        ]
      },
      {
        "id": "Definition.date",
        "path": "Definition.date",
        "short": "Date status first applied",
        "definition": "For draft definitions, indicates the date of initial creation.  For active definitions, represents the date of activation.  For withdrawn definitions, indicates the date of withdrawal.",
        "alias": [
          "created"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=AUT].time"
          },
          {
            "identity": "w5",
            "map": "when.recorded"
          }
        ]
      },
      {
        "id": "Definition.author",
        "path": "Definition.author",
        "short": "Who/what is requesting service",
        "definition": "The individual or group with primary responsibility for the content of this definition.",
        "alias": [
          "author"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Organization"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=AUT].role"
          },
          {
            "identity": "w5",
            "map": "who.author"
          }
        ]
      },
      {
        "id": "Definition.performerType",
        "path": "Definition.performerType",
        "short": "Desired kind of service performer",
        "definition": "The type of individual that is expected to act upon instances of this definition.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "isSummary": true,
        "binding": {
          "strength": "example",
          "description": "Identifies types of practitioners, devices or others that are intended to perform a defined action.  While the detailed constraints of relevant providers will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode=PRF].role[scoper.determinerCode=KIND].code"
          },
          {
            "identity": "w5",
            "map": "who.actor"
          }
        ]
      }
    ]
  }
}