Other.profile.xml

Profile for other

{
  "resourceType": "Profile",
  "text": {
    "status": "generated",
    "div": "<div><pre>\r\n&lt;<a title=\"Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.\" class=\"dict\" href=\"other-definitions.html#Other\"><b>Other</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n &lt;!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> --&gt;\r\n &lt;<a title=\"Identifier assigned to the resource for business purposes, outside the context of FHIR.\" class=\"dict\" href=\"other-definitions.html#Other.identifier\"><b>identifier</b></a>&gt;<span style=\"color: Gray\">&lt;!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --&gt;</span>&lt;/identifier&gt;\r\n &lt;<a title=\"Identifies the 'type' of resource - equivalent to the resource name for other resources (this element modifies the meaning of other elements)\" class=\"dict\" href=\"other-definitions.html#Other.code\"><span style=\"text-decoration: underline\"><b>code</b></span></a>&gt;<span style=\"color: Gray\">&lt;!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-other-resource-type.html\">Kind of Resource</a></span><span style=\"color: Gray\"> --&gt;</span>&lt;/code&gt;\r\n &lt;<a title=\"Identifies the patient, practitioner, device or any other resource that is the &quot;focus&quot; of this resoruce.\" class=\"dict\" href=\"other-definitions.html#Other.subject\"><b>subject</b></a>&gt;<span style=\"color: Gray\">&lt;!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Identifies the</span><span style=\"color: Gray\"> --&gt;</span>&lt;/subject&gt;\r\n &lt;<a title=\"Indicates who was responsible for creating the resource instance.\" class=\"dict\" href=\"other-definitions.html#Other.author\"><b>author</b></a>&gt;<span style=\"color: Gray\">&lt;!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"relatedperson.html#RelatedPerson\">RelatedPerson</a>)</span> <span style=\"color: navy\">Who created</span><span style=\"color: Gray\"> --&gt;</span>&lt;/author&gt;\r\n &lt;<a title=\"Identifies when the resource was first created.\" class=\"dict\" href=\"other-definitions.html#Other.created\"><b>created</b></a> value=&quot;[<span style=\"color: darkgreen\"><a href=\"datatypes.html#date\">date</a></span>]&quot;/&gt;<span style=\"color: Gray\">&lt;!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When created</span><span style=\"color: Gray\"> --&gt;</span>\r\n&lt;/Other&gt;\r\n</pre></div>"
  },
  "name": "other",
  "publisher": "FHIR Project",
  "description": "Basic Profile. Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.",
  "status": "draft",
  "date": "2014-09-30",
  "requirements": "Scope and Usage Other is a special type of resource. Unlike all other resources, it doesn't correspond to a specific identifiable real-world concept. Instead, it's a placeholder for any resource-like concept that isn't already defined in the HL7 specification. \r\n\r\nThe Other resource is intended for use in two circumstances: \r\n\r\n* When an implementer needs a resource concept that is likely to be defined by HL7 in the future but they have not yet done so (due to bandwidth issues, lack of sufficient requirements, lower prioritization, etc.)\r\n* When the resource concept falls \"outside the 99%\" - i.e. less than 1% of the systems that use FHIR are likely to ever make use of the resource. To keep the specification manageable, it cannot incorporate every esoteric requirement that might be needed in some implementation somewhere. This set of resources likely won't ever be officially defined in HL7.\r\nThere's also a third circumstance: An implementer wishes to convey information that could/should be conveyed using a standard resource, however they want to represent the information in a custom format that isn't aligned with the official resource's elements. While this resource would be the preferred way of meeting that use-case because it will at least be wire-format compatible, such a use would not be conformant because making use of the Other resource would prevent the healthcare-related information from being safely processed, queried and analyzed by other conformant systems. \r\n\r\nImplementers don't really need to be concerned with one of the two categories their desired resource fits within. If they need a resource and it doesn't yet exist, they should use Other.",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "structure": [
    {
      "type": "Other",
      "publish": true,
      "element": [
        {
          "path": "Other",
          "definition": {
            "short": "Resource for non-supported content",
            "formal": "Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest.",
            "min": 1,
            "max": "1",
            "type": [
              {
                "code": "Resource"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": "Act, Entity or Role"
              }
            ]
          }
        },
        {
          "path": "Other.extension",
          "definition": {
            "short": "Additional Content defined by implementations",
            "formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
            "comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
            "synonym": [
              "extensions",
              "user content"
            ],
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Extension"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Other.modifierExtension",
          "definition": {
            "short": "Extensions that cannot be ignored",
            "formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
            "comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
            "synonym": [
              "extensions",
              "user content"
            ],
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Extension"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Other.text",
          "definition": {
            "short": "Text summary of the resource, for human interpretation",
            "formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
            "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
            "synonym": [
              "narrative",
              "html",
              "xhtml",
              "display"
            ],
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "Narrative"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Other.contained",
          "definition": {
            "short": "Contained, inline Resources",
            "formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
            "comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
            "synonym": [
              "inline resources",
              "anonymous resources",
              "contained resources"
            ],
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Resource"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Other.identifier",
          "definition": {
            "short": "Business identifier",
            "formal": "Identifier assigned to the resource for business purposes, outside the context of FHIR.",
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Identifier"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": "./identifier"
              }
            ]
          }
        },
        {
          "path": "Other.code",
          "definition": {
            "short": "Kind of Resource",
            "formal": "Identifies the 'type' of resource - equivalent to the resource name for other resources.",
            "comments": "Because resource references will only be able to indicate 'Other', the type of reference will need to be specified in a Profile identified as part of the resource.  Refer to the resource notes section for information on appropriate terminologies for this code.",
            "min": 1,
            "max": "1",
            "type": [
              {
                "code": "CodeableConcept"
              }
            ],
            "isModifier": true,
            "binding": {
              "name": "OtherResourceType",
              "isExtensible": true,
              "conformance": "example",
              "referenceResource": {
                "reference": "http://hl7.org/fhir/vs/other-resource-type"
              }
            },
            "mapping": [
              {
                "identity": "rim",
                "map": "./code"
              }
            ]
          }
        },
        {
          "path": "Other.subject",
          "definition": {
            "short": "Identifies the",
            "formal": "Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resoruce.",
            "comments": "Optional as not all resources potential resources will have subjects.  Resources associated with multiple subjects can handle this via extension.",
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Any"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": "./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"
              }
            ]
          }
        },
        {
          "path": "Other.author",
          "definition": {
            "short": "Who created",
            "formal": "Indicates who was responsible for creating the resource instance.",
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Practitioner"
              },
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Patient"
              },
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/RelatedPerson"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": "./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"
              }
            ]
          }
        },
        {
          "path": "Other.created",
          "definition": {
            "short": "When created",
            "formal": "Identifies when the resource was first created.",
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "date"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": "./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"
              }
            ]
          }
        }
      ],
      "searchParam": [
        {
          "name": "_id",
          "type": "token",
          "documentation": "The logical resource id associated with the resource (must be supported by all servers)"
        },
        {
          "name": "_language",
          "type": "token",
          "documentation": "The language of the resource"
        },
        {
          "name": "code",
          "type": "token",
          "documentation": "Kind of Resource",
          "xpath": "f:Other/f:code"
        },
        {
          "name": "created",
          "type": "date",
          "documentation": "When created",
          "xpath": "f:Other/f:created"
        },
        {
          "name": "subject",
          "type": "reference",
          "documentation": "Identifies the",
          "xpath": "f:Other/f:subject"
        }
      ]
    }
  ]
}