HL7 FHIR® Implementation Guide: Breast Cancer Data, Release 1 - US Realm (Draft for Comment)

This page is part of the Breast Cancer Data Logical Models and FHIR Profiles (v0.1.0: STU 1 Draft) based on FHIR R3. . For a full list of available versions, see the Directory of published versions

EncounterExtension

{
  "resourceType" : "StructureDefinition",
  "id" : "cimi-Encounter-extension",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml">
  <p><b>BC Encounter Extension</b></p>
  <p>An abstract class that represents an encounter class. This class has been stubbed out to limit the scope of this implementation guide to classes relevant to this ballot concerning breast cancer.</p>
</div>"
  },
  "url" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Encounter-extension",
  "identifier" : [
    {
      "system" : "http://hl7.org/fhir/us/breastcancer",
      "value" : "cimi.Encounter"
    }
  ],
  "version" : "0.1.0",
  "name" : "EncounterExtension",
  "title" : "BC Encounter Extension",
  "status" : "draft",
  "date" : "2018-04-01T00:00:00+11:00",
  "publisher" : "The HL7 Cancer Interoperability Group sponsored by Clinical Interoperability Council Work Group (CIC)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://standardhealthrecord.org"
        }
      ]
    }
  ],
  "description" : "An abstract class that represents an encounter class. This class has been stubbed out to limit the scope of this implementation guide to classes relevant to this ballot concerning breast cancer.",
  "fhirVersion" : "3.0.1",
  "kind" : "complex-type",
  "abstract" : false,
  "contextType" : "resource",
  "context" : [
    "*"
  ],
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "snapshot" : {
    "element" : [
      {
        "id" : "Extension:encounter",
        "path" : "Extension",
        "short" : "BC Encounter Extension",
        "definition" : "An abstract class that represents an encounter class. This class has been stubbed out to limit the scope of this implementation guide to classes relevant to this ballot concerning breast cancer.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Extension",
          "min" : 0,
          "max" : "1"
        },
        "condition" : [
          "ele-1"
        ],
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "children().count() > id.count()",
            "xpath" : "@value|f:*|h:div",
            "source" : "Element"
          },
          {
            "key" : "ext-1",
            "severity" : "error",
            "human" : "Must have either extensions or value[x], not both",
            "expression" : "extension.exists() != value.exists()",
            "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source" : "Extension"
          }
        ]
      },
      {
        "id" : "Extension:encounter.id",
        "path" : "Extension.id",
        "representation" : [
          "xmlAttr"
        ],
        "short" : "xml:id (or equivalent in JSON)",
        "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Element.id",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ],
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        ]
      },
      {
        "id" : "Extension:encounter.extension",
        "path" : "Extension.extension",
        "slicing" : {
          "id" : "1",
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        },
        "short" : "Extension",
        "definition" : "An Extension",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Element.extension",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Extension"
          }
        ]
      },
      {
        "id" : "Extension:encounter.url",
        "path" : "Extension.url",
        "representation" : [
          "xmlAttr"
        ],
        "short" : "identifies the meaning of the extension",
        "definition" : "Source of the definition for the extension code - a logical name or a URL.",
        "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Extension.url",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        ],
        "fixedUri" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Encounter-extension",
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        ]
      },
      {
        "id" : "Extension:encounter.value[x]",
        "path" : "Extension.value[x]",
        "short" : "Value of extension",
        "definition" : "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
        "min" : 0,
        "max" : "0",
        "base" : {
          "path" : "Extension.value[x]",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "base64Binary"
          },
          {
            "code" : "boolean"
          },
          {
            "code" : "code"
          },
          {
            "code" : "date"
          },
          {
            "code" : "dateTime"
          },
          {
            "code" : "decimal"
          },
          {
            "code" : "id"
          },
          {
            "code" : "instant"
          },
          {
            "code" : "integer"
          },
          {
            "code" : "markdown"
          },
          {
            "code" : "oid"
          },
          {
            "code" : "positiveInt"
          },
          {
            "code" : "string"
          },
          {
            "code" : "time"
          },
          {
            "code" : "unsignedInt"
          },
          {
            "code" : "uri"
          },
          {
            "code" : "Address"
          },
          {
            "code" : "Age"
          },
          {
            "code" : "Annotation"
          },
          {
            "code" : "Attachment"
          },
          {
            "code" : "CodeableConcept"
          },
          {
            "code" : "Coding"
          },
          {
            "code" : "ContactPoint"
          },
          {
            "code" : "Count"
          },
          {
            "code" : "Distance"
          },
          {
            "code" : "Duration"
          },
          {
            "code" : "HumanName"
          },
          {
            "code" : "Identifier"
          },
          {
            "code" : "Money"
          },
          {
            "code" : "Period"
          },
          {
            "code" : "Quantity"
          },
          {
            "code" : "Range"
          },
          {
            "code" : "Ratio"
          },
          {
            "code" : "Reference"
          },
          {
            "code" : "SampledData"
          },
          {
            "code" : "Signature"
          },
          {
            "code" : "Timing"
          },
          {
            "code" : "Meta"
          }
        ],
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        ]
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "Extension:encounter",
        "path" : "Extension",
        "short" : "BC Encounter Extension",
        "definition" : "An abstract class that represents an encounter class. This class has been stubbed out to limit the scope of this implementation guide to classes relevant to this ballot concerning breast cancer.",
        "min" : 0,
        "max" : "*"
      },
      {
        "id" : "Extension:encounter.url",
        "path" : "Extension.url",
        "type" : [
          {
            "code" : "uri"
          }
        ],
        "fixedUri" : "http://hl7.org/fhir/us/breastcancer/StructureDefinition/cimi-Encounter-extension"
      },
      {
        "id" : "Extension:encounter.value[x]",
        "path" : "Extension.value[x]",
        "min" : 0,
        "max" : "0"
      }
    ]
  }
}