2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Namingsystem.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for NamingSystem

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "publisher": "HL7 FHIR Project (FHIR Management Group)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc.  Represents a \"System\" used within the Identifier and Coding data types."
      }
    ],
    "linkId": "NamingSystem",
    "title": "System of unique identification",
    "required": true,
    "repeats": false,
    "group": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. 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."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "NamingSystem.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.id.value",
            "text": "Logical id of this artefact",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          }
        ],
        "linkId": "NamingSystem.meta",
        "text": "Metadata about the resource",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "uri"
          }
        ],
        "linkId": "NamingSystem.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.implicitRules.value",
            "text": "A set of rules under which this content was created",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The base language in which the resource is written. 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)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "NamingSystem.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.language.value",
            "text": "language",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
          }
        ],
        "linkId": "NamingSystem.text",
        "text": "Text summary of the resource, for human interpretation",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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. 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."
          }
        ],
        "linkId": "NamingSystem.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Indicates the purpose for the namingsystem - what kinds of things does it make unique?."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "NamingSystem.type",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.type.value",
            "text": "type",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The descriptive name of this particular identifier type or code system. The\"symbolic name\" for an OID would be captured as an extension."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "NamingSystem.name",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.name.value",
            "text": "Human-readable label",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The date  (and optionally time) when the system was registered or published."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "datetime"
          }
        ],
        "linkId": "NamingSystem.date",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.date.value",
            "text": "Publication Date(/time)",
            "type": "dateTime",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Indicates whether the namingsystem is \"ready for use\" or not."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "NamingSystem.status",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.status.value",
            "text": "status",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "If present, indicates that the identifier or code system is principally intended for use or applies to entities within the specified country.  For example, the country associated with a national code system."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "NamingSystem.country",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.country.value",
            "text": "country",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Categorizes a namingsystem for easier search by grouping related namingsystems. This will most commonly be used for identifier namespaces, but categories could potentially be useful for code systems and authorities as well."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "CodeableConcept"
          }
        ],
        "linkId": "NamingSystem.category",
        "text": "driver | provider | patient | bank",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.category.coding",
            "text": "code:",
            "type": "open-choice",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "NamingSystem.category.text",
            "text": "text:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. This is the primary organization.  Responsibility for some aspects of a namespace may be delegated."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "NamingSystem.responsible",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.responsible.value",
            "text": "Who maintains system namespace?",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Details about what the namespace identifies including scope, granularity, version labeling, etc."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "NamingSystem.description",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.description.value",
            "text": "What does namingsystem identify?",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "NamingSystem.usage",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.usage.value",
            "text": "How/where is it used",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Indicates how the system may be identified when referenced in electronic exchange."
          }
        ],
        "linkId": "NamingSystem.uniqueId",
        "title": "Unique identifiers used for system",
        "text": "Multiple identifiers may exist, either due to duplicate registration, regional rules, needs of different communication technologies, etc.",
        "required": true,
        "repeats": true,
        "group": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "unique id for the element within a resource (for internal references)."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "NamingSystem.uniqueId.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.uniqueId.id.value",
                "text": "xml:id (or equivalent in JSON)",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Identifies the unique identifier scheme used for this particular identifier. Different identifier types may be used in different types of communications (OIDs for v3, URIs for FHIR, etc.).  Other includes RUIDs from v3, standard v2 code name strings, etc."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "code"
              }
            ],
            "linkId": "NamingSystem.uniqueId.type",
            "required": true,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.uniqueId.type.value",
                "text": "type",
                "type": "choice",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "The string that should be sent over the wire to identify the code system or identifier system."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "NamingSystem.uniqueId.value",
            "required": true,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.uniqueId.value.value",
                "text": "The unique identifier",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Indicates whether this identifier is the \"preferred\" identifier of this type."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "boolean"
              }
            ],
            "linkId": "NamingSystem.uniqueId.preferred",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.uniqueId.preferred.value",
                "text": "Is this the id that should be used for this type",
                "type": "boolean",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Identifies the period of time over which this identifier is considered appropriate to refer to the namingsystem.  Outside of this window, the identifier might be non-deterministic. Within a registry, a given identifier should only be \"active\" for a single namespace at a time.  (Ideally, an identifier should only ever be associated with a single namespace across all time)."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Period"
              }
            ],
            "linkId": "NamingSystem.uniqueId.period",
            "text": "When is identifier valid?",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.uniqueId.period.low",
                "text": "start:",
                "type": "dateTime",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "NamingSystem.uniqueId.period.end",
                "text": "end:",
                "type": "dateTime",
                "required": false,
                "repeats": false
              }
            ]
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The name of the individual or organization that published the naming system. Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "NamingSystem.publisher",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "NamingSystem.publisher.value",
            "text": "Name of the publisher (Organization or individual)",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Contacts to assist a user in finding and communicating with the publisher."
          }
        ],
        "linkId": "NamingSystem.contact",
        "title": "Contact details of the publisher",
        "text": "May be a web site, an email address, a telephone number (tel:), etc.",
        "required": false,
        "repeats": true,
        "group": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "unique id for the element within a resource (for internal references)."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "NamingSystem.contact.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.contact.id.value",
                "text": "xml:id (or equivalent in JSON)",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "The name of an individual to contact regarding the naming system. If there is no named individual, the telecom is for the organization as a whole."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "NamingSystem.contact.name",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.contact.name.value",
                "text": "Name of a individual to contact",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Contact details for individual (if a name was provided) or the publisher."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "ContactPoint"
              }
            ],
            "linkId": "NamingSystem.contact.telecom",
            "text": "Contact details for individual or publisher",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "NamingSystem.contact.telecom.system",
                "text": "type:",
                "type": "choice",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "NamingSystem.contact.telecom.value",
                "text": "value:",
                "type": "string",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "NamingSystem.contact.telecom.use",
                "text": "use:",
                "type": "choice",
                "required": false,
                "repeats": false
              }
            ]
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "For namingsystems that are retired, indicates the namingsystem that should be used in their place (if any)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "NamingSystem.replacedBy",
        "required": false,
        "repeats": true,
        "question": [
          {
            "extension": [
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                "valueString": "/NamingSystem?subject=$subj&patient=$subj&encounter=$encounter"
              }
            ],
            "linkId": "NamingSystem.replacedBy.value",
            "text": "Use this instead",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      }
    ]
  }
}

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.