STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Ccda/CR.json

Raw JSON (canonical form)

Logical Model V3 Data type CR (ConceptRole)

{
  "resourceType": "StructureDefinition",
  "id": "CR",
  "extension": [
    {
      "url": "http://www.healthintersections.com.au/fhir/StructureDefinition/extension-namespace",
      "valueUri": "urn:hl7-org:v3"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/CR",
  "name": "V3 Data type CR (ConceptRole)",
  "display": "V3 Data type CR (ConceptRole)",
  "status": "active",
  "experimental": false,
  "publisher": "HL7",
  "description": "A concept qualifier code with optionally named role. Both qualifier role and value codes must be defined by the coding system of the CD containing the concept qualifier. For example, if SNOMED RT defines a concept \"leg\", a role relation \"has-laterality\", and another concept \"left\", the concept role relation allows to add the qualifier \"has-laterality: left\" to a primary code \"leg\" to construct the meaning \"left leg\".",
  "kind": "logical",
  "abstract": false,
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ANY",
  "snapshot": {
    "element": [
      {
        "path": "CR",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "CR.nullFlavor",
        "representation": [
          "xmlAttr"
        ],
        "label": "Exceptional Value Detail",
        "definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/ValueSet/v3-NullFlavor"
          }
        }
      },
      {
        "path": "CR.name",
        "label": "Name",
        "definition": "Specifies the manner in which the concept role value contributes to the meaning of a code phrase. For example, if SNOMED RT defines a concept \"leg\", a role relation \"has-laterality\", and another concept \"left\", the concept role relation allows to add the qualifier \"has-laterality: left\" to a primary code \"leg\" to construct the meaning \"left leg\". In this example \"has-laterality\" is the CR.name.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CV"
          }
        ]
      },
      {
        "path": "CR.value",
        "label": "Value",
        "definition": "The concept that modifies the primary code of a code phrase through the role relation. For example, if SNOMED RT defines a concept \"leg\", a role relation \"has-laterality\", and another concept \"left\", the concept role relation allows adding the qualifier \"has-laterality: left\" to a primary code \"leg\" to construct the meaning \"left leg\". In this example \"left\" is the CR.value.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CD"
          }
        ]
      },
      {
        "path": "CR.inverted",
        "representation": [
          "xmlAttr"
        ],
        "label": "Inversion Indicator",
        "definition": "Indicates if the sense of the role name is inverted. This can be used in cases where the underlying code system defines inversion but does not provide reciprocal pairs of role names. By default, inverted is false.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "BN"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "CR",
        "min": 1,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "CR.name",
        "label": "Name",
        "definition": "Specifies the manner in which the concept role value contributes to the meaning of a code phrase. For example, if SNOMED RT defines a concept \"leg\", a role relation \"has-laterality\", and another concept \"left\", the concept role relation allows to add the qualifier \"has-laterality: left\" to a primary code \"leg\" to construct the meaning \"left leg\". In this example \"has-laterality\" is the CR.name.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CV"
          }
        ]
      },
      {
        "path": "CR.value",
        "label": "Value",
        "definition": "The concept that modifies the primary code of a code phrase through the role relation. For example, if SNOMED RT defines a concept \"leg\", a role relation \"has-laterality\", and another concept \"left\", the concept role relation allows adding the qualifier \"has-laterality: left\" to a primary code \"leg\" to construct the meaning \"left leg\". In this example \"left\" is the CR.value.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CD"
          }
        ]
      },
      {
        "path": "CR.inverted",
        "representation": [
          "xmlAttr"
        ],
        "label": "Inversion Indicator",
        "definition": "Indicates if the sense of the role name is inverted. This can be used in cases where the underlying code system defines inversion but does not provide reciprocal pairs of role names. By default, inverted is false.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "BN"
          }
        ]
      }
    ]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.