Binary.profile.json

StructureDefinition for binary

{
  "resourceType": "StructureDefinition",
  "id": "Binary",
  "meta": {
    "lastUpdated": "2015-04-03T14:24:32.000+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/Binary",
  "name": "Binary",
  "publisher": "HL7 FHIR Project (FHIR Management Group)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fhirmg/index.cfm"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for Binary Resource",
  "status": "draft",
  "date": "2015-04-03T14:24:32+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "Binary",
        "short": "Pure binary content defined by sime other format than FHIR",
        "definition": "A binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
        "comments": "Typically, Binary resources are used for handling content such as:\n\n* CDA Documents (i.e. with XDS)\n* PDF Documents\n* Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
        "requirements": "There are situations where it is useful or required to handle pure binary content using the same framework as other resources.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "Binary.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "Binary.meta",
        "short": "Metadata about the resource",
        "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "Binary.implicitRules",
        "short": "A set of rules under which this content was created",
        "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
        "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "Binary.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Language",
          "strength": "required",
          "description": "A human language",
          "valueSetUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "Binary.contentType",
        "short": "MimeType of the binary content",
        "definition": "MimeType of the binary content represented as a standard MimeType (BCP 13).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "MimeType",
          "strength": "required",
          "description": "The mime type of an attachment",
          "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
        }
      },
      {
        "path": "Binary.content",
        "short": "The actual content",
        "definition": "The actual content, base64 encoded.",
        "comments": "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "base64Binary"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "Binary",
        "short": "Pure binary content defined by sime other format than FHIR",
        "definition": "A binary resource can contain any content, whether text, image, pdf, zip archive, etc.",
        "comments": "Typically, Binary resources are used for handling content such as:\n\n* CDA Documents (i.e. with XDS)\n* PDF Documents\n* Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS).",
        "requirements": "There are situations where it is useful or required to handle pure binary content using the same framework as other resources.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "Binary.contentType",
        "short": "MimeType of the binary content",
        "definition": "MimeType of the binary content represented as a standard MimeType (BCP 13).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "MimeType",
          "strength": "required",
          "description": "The mime type of an attachment",
          "valueSetUri": "http://www.rfc-editor.org/bcp/bcp13.txt"
        }
      },
      {
        "path": "Binary.content",
        "short": "The actual content",
        "definition": "The actual content, base64 encoded.",
        "comments": "If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "base64Binary"
          }
        ]
      }
    ]
  }
}