Devicecomponent.profile.json

StructureDefinition for devicecomponent

{
  "resourceType": "StructureDefinition",
  "id": "DeviceComponent",
  "meta": {
    "lastUpdated": "2015-03-27T00:13:00.999+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/DeviceComponent",
  "name": "DeviceComponent",
  "publisher": "HL7 FHIR Project (Healthcare Devices)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/healthcaredevices/index.cfm"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for DeviceComponent Resource",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "DeviceComponent",
        "short": "An instance of a medical-related component of a medical device",
        "definition": "Describes the characteristics, operational status and capabilities of a medical-related component of a medical device.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DeviceComponent"
          }
        ]
      },
      {
        "path": "DeviceComponent.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": "DeviceComponent.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": "DeviceComponent.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": "DeviceComponent.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": "DeviceComponent.text",
        "short": "Text summary of the resource, for human interpretation",
        "definition": "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.",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "DeviceComponent.contained",
        "short": "Contained, inline Resources",
        "definition": "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.",
        "alias": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceComponent.extension",
        "short": "Additional Content defined by implementations",
        "definition": "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 set of 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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceComponent.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "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 set of 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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceComponent.type",
        "short": "What kind of component it is",
        "definition": "Describes the specific component type as defined in the object-oriented or metric nomenclature partition.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "ComponentType",
          "strength": "required",
          "description": "Describes the type of the component",
          "valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
        }
      },
      {
        "path": "DeviceComponent.identifier",
        "short": "Instance id assigned by the software stack",
        "definition": "Describes the local assigned unique identification by the software. For example: handle ID.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "DeviceComponent.lastSystemChange",
        "short": "Recent system change timestamp",
        "definition": "Describes the timestamp for the most recent system change which includes device configuration or setting change.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "instant"
          }
        ]
      },
      {
        "path": "DeviceComponent.source",
        "short": "A source device of this component",
        "definition": "Describes the link to the source Device that contains administrative device information such as manufacture, serial number, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ]
      },
      {
        "path": "DeviceComponent.parent",
        "short": "Parent resource link",
        "definition": "Describes the link to the parent resource. For example: Channel is linked to its VMD parent.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
          }
        ]
      },
      {
        "path": "DeviceComponent.operationalStatus",
        "short": "Component operational status",
        "definition": "Indicates current operational status of the device. For example: On, Off, Standby, etc.",
        "comments": "OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that is defined in its profile.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "DeviceComponent.parameterGroup",
        "short": "Current supported parameter group",
        "definition": "Describes the parameter group supported by the current device component that is based on some nomenclature, e.g., cardiovascular.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "DeviceComponent.measurementPrinciple",
        "short": "other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+",
        "definition": "Describes the physical principle of the measurement. For example: thermal, chemical, acoustical, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Measmnt-Principle",
          "strength": "required",
          "description": "Different measurement principle supported by the device",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/measurement-principle"
          }
        }
      },
      {
        "path": "DeviceComponent.productionSpecification",
        "short": "Production specification of the component",
        "definition": "Describes the production specification such as component revision, serial number, etc.",
        "min": 0,
        "max": "*"
      },
      {
        "path": "DeviceComponent.productionSpecification.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element, 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 set of 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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.specType",
        "short": "Specification type",
        "definition": "Describes the specification type, such as, serial number, part number, hardware revision, software revision, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.componentId",
        "short": "Internal component unique identification",
        "definition": "Describes the internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacture can make use of.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.productionSpec",
        "short": "A printable string defining the component",
        "definition": "Describes the printable string defining the component.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "DeviceComponent.languageCode",
        "short": "Language code for the human-readable text strings produced by the device",
        "definition": "Describes the language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "DeviceComponent",
        "short": "An instance of a medical-related component of a medical device",
        "definition": "Describes the characteristics, operational status and capabilities of a medical-related component of a medical device.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ]
      },
      {
        "path": "DeviceComponent.type",
        "short": "What kind of component it is",
        "definition": "Describes the specific component type as defined in the object-oriented or metric nomenclature partition.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "ComponentType",
          "strength": "required",
          "description": "Describes the type of the component",
          "valueSetUri": "https://rtmms.nist.gov/rtmms/index.htm#!hrosetta"
        }
      },
      {
        "path": "DeviceComponent.identifier",
        "short": "Instance id assigned by the software stack",
        "definition": "Describes the local assigned unique identification by the software. For example: handle ID.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "DeviceComponent.lastSystemChange",
        "short": "Recent system change timestamp",
        "definition": "Describes the timestamp for the most recent system change which includes device configuration or setting change.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "instant"
          }
        ]
      },
      {
        "path": "DeviceComponent.source",
        "short": "A source device of this component",
        "definition": "Describes the link to the source Device that contains administrative device information such as manufacture, serial number, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ]
      },
      {
        "path": "DeviceComponent.parent",
        "short": "Parent resource link",
        "definition": "Describes the link to the parent resource. For example: Channel is linked to its VMD parent.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/DeviceComponent"
          }
        ]
      },
      {
        "path": "DeviceComponent.operationalStatus",
        "short": "Component operational status",
        "definition": "Indicates current operational status of the device. For example: On, Off, Standby, etc.",
        "comments": "OperationalStatus for the MDS, VMD, or Channel will be bound to a specific ValueSet that is defined in its profile.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "DeviceComponent.parameterGroup",
        "short": "Current supported parameter group",
        "definition": "Describes the parameter group supported by the current device component that is based on some nomenclature, e.g., cardiovascular.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "DeviceComponent.measurementPrinciple",
        "short": "other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+",
        "definition": "Describes the physical principle of the measurement. For example: thermal, chemical, acoustical, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Measmnt-Principle",
          "strength": "required",
          "description": "Different measurement principle supported by the device",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/measurement-principle"
          }
        }
      },
      {
        "path": "DeviceComponent.productionSpecification",
        "short": "Production specification of the component",
        "definition": "Describes the production specification such as component revision, serial number, etc.",
        "min": 0,
        "max": "*"
      },
      {
        "path": "DeviceComponent.productionSpecification.specType",
        "short": "Specification type",
        "definition": "Describes the specification type, such as, serial number, part number, hardware revision, software revision, etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.componentId",
        "short": "Internal component unique identification",
        "definition": "Describes the internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacture can make use of.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "path": "DeviceComponent.productionSpecification.productionSpec",
        "short": "A printable string defining the component",
        "definition": "Describes the printable string defining the component.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "DeviceComponent.languageCode",
        "short": "Language code for the human-readable text strings produced by the device",
        "definition": "Describes the language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      }
    ]
  }
}