Searchparameter.profile.json

StructureDefinition for searchparameter

{
  "resourceType": "StructureDefinition",
  "id": "SearchParameter",
  "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/SearchParameter",
  "name": "SearchParameter",
  "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 SearchParameter Resource",
  "status": "draft",
  "date": "2015-03-27T00:13:00+11:00",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "type": "resource",
  "abstract": true,
  "snapshot": {
    "element": [
      {
        "path": "SearchParameter",
        "short": "Search Parameter for a resource",
        "definition": "A Search Parameter that defines a named search item that can be used to search/filter on a resource.",
        "comments": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "SearchParameter"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "SearchParameter.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": "SearchParameter.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": "SearchParameter.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": "SearchParameter.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": "SearchParameter.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": "SearchParameter.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": "SearchParameter.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": "SearchParameter.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": "SearchParameter.url",
        "short": "Literal URL used to reference this search parameter",
        "definition": "An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements.",
        "requirements": "To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "path": "SearchParameter.name",
        "short": "Name of search parameter",
        "definition": "The name of the standard or custom search parameter.",
        "comments": "This is the name to be used for this parameter in the search parameters in the URL.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.publisher",
        "short": "Name of the publisher (Organization or individual)",
        "definition": "The name of the individual or organization that published the search parameter.",
        "comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
        "requirements": "Helps establish the \"authority/credibility\" of the search parameter.  May also allow for contact.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.contact",
        "short": "Contact details of the publisher",
        "definition": "Contacts to assist a user in finding and communicating with the publisher.",
        "comments": "May be a web site, an email address, a telephone number (tel:), etc.",
        "min": 0,
        "max": "*",
        "isSummary": true
      },
      {
        "path": "SearchParameter.contact.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": "SearchParameter.contact.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": "SearchParameter.contact.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": "SearchParameter.contact.name",
        "short": "Name of a individual to contact",
        "definition": "The name of an individual to contact regarding the search parameter.",
        "comments": "If there is no named individual, the telecom is for the organization as a whole.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.contact.telecom",
        "short": "Contact details for individual or publisher",
        "definition": "Contact details for individual (if a name was provided) or the publisher.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactPoint"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.requirements",
        "short": "Why this search parameter is defined",
        "definition": "The Scope and Usage that this search parameter was created to meet.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "SearchParameter.status",
        "short": "draft | active | retired",
        "definition": "The status of this search parameter definition.",
        "comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "name": "ConformanceResourceStatus",
          "strength": "required",
          "description": "The lifecycle status of a Value Set or Concept Map",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/conformance-resource-status"
          }
        }
      },
      {
        "path": "SearchParameter.experimental",
        "short": "If for testing purposes, not real usage",
        "definition": "A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
        "comments": "Allows filtering of search parameter definitions that are appropriate for use vs. not.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.date",
        "short": "Publication Date(/time)",
        "definition": "The date  (and optionally time) when the search parameter definition was published.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.base",
        "short": "The resource type this search parameter applies to",
        "definition": "The base resource type that this search parameter refers to.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "ResourceType",
          "strength": "required",
          "description": "One of the resource types defined as part of FHIR",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/resource-types"
          }
        }
      },
      {
        "path": "SearchParameter.type",
        "short": "number | date | string | token | reference | composite | quantity | uri",
        "definition": "The type of value a search parameter refers to, and how the content is interpreted.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "SearchParamType",
          "strength": "required",
          "description": "Data types allowed to be used for search parameters",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/search-param-type"
          }
        }
      },
      {
        "path": "SearchParameter.description",
        "short": "Documentation for  search parameter",
        "definition": "A description of the search parameters and how it used.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "SearchParameter.xpath",
        "short": "XPath that extracts the values",
        "definition": "An XPath expression that returns a set of elements for the search parameter.",
        "comments": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them. E.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "SearchParameter.target",
        "short": "Types of resource (if a resource reference)",
        "definition": "Types of resource (if a resource is referenced).",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "ResourceType",
          "strength": "required",
          "description": "One of the resource types defined as part of FHIR",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/resource-types"
          }
        }
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "SearchParameter",
        "short": "Search Parameter for a resource",
        "definition": "A Search Parameter that defines a named search item that can be used to search/filter on a resource.",
        "comments": "In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "DomainResource"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "SearchParameter.url",
        "short": "Literal URL used to reference this search parameter",
        "definition": "An absolute URL at which this search parameter is (or will be) published, and which is used to reference this profile in conformance statements.",
        "requirements": "To allow referencing and reusing search parameter definitions under other names on operational systems (in case of name clash).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ]
      },
      {
        "path": "SearchParameter.name",
        "short": "Name of search parameter",
        "definition": "The name of the standard or custom search parameter.",
        "comments": "This is the name to be used for this parameter in the search parameters in the URL.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.publisher",
        "short": "Name of the publisher (Organization or individual)",
        "definition": "The name of the individual or organization that published the search parameter.",
        "comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
        "requirements": "Helps establish the \"authority/credibility\" of the search parameter.  May also allow for contact.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.contact",
        "short": "Contact details of the publisher",
        "definition": "Contacts to assist a user in finding and communicating with the publisher.",
        "comments": "May be a web site, an email address, a telephone number (tel:), etc.",
        "min": 0,
        "max": "*",
        "isSummary": true
      },
      {
        "path": "SearchParameter.contact.name",
        "short": "Name of a individual to contact",
        "definition": "The name of an individual to contact regarding the search parameter.",
        "comments": "If there is no named individual, the telecom is for the organization as a whole.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.contact.telecom",
        "short": "Contact details for individual or publisher",
        "definition": "Contact details for individual (if a name was provided) or the publisher.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactPoint"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.requirements",
        "short": "Why this search parameter is defined",
        "definition": "The Scope and Usage that this search parameter was created to meet.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "SearchParameter.status",
        "short": "draft | active | retired",
        "definition": "The status of this search parameter definition.",
        "comments": "This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "name": "ConformanceResourceStatus",
          "strength": "required",
          "description": "The lifecycle status of a Value Set or Concept Map",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/conformance-resource-status"
          }
        }
      },
      {
        "path": "SearchParameter.experimental",
        "short": "If for testing purposes, not real usage",
        "definition": "A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
        "comments": "Allows filtering of search parameter definitions that are appropriate for use vs. not.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.date",
        "short": "Publication Date(/time)",
        "definition": "The date  (and optionally time) when the search parameter definition was published.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true
      },
      {
        "path": "SearchParameter.base",
        "short": "The resource type this search parameter applies to",
        "definition": "The base resource type that this search parameter refers to.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "ResourceType",
          "strength": "required",
          "description": "One of the resource types defined as part of FHIR",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/resource-types"
          }
        }
      },
      {
        "path": "SearchParameter.type",
        "short": "number | date | string | token | reference | composite | quantity | uri",
        "definition": "The type of value a search parameter refers to, and how the content is interpreted.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "SearchParamType",
          "strength": "required",
          "description": "Data types allowed to be used for search parameters",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/search-param-type"
          }
        }
      },
      {
        "path": "SearchParameter.description",
        "short": "Documentation for  search parameter",
        "definition": "A description of the search parameters and how it used.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "SearchParameter.xpath",
        "short": "XPath that extracts the values",
        "definition": "An XPath expression that returns a set of elements for the search parameter.",
        "comments": "Note that the elements returned by the XPath are sometimes complex elements where logic is required to determine quite how to handle them. E.g. CodeableConcepts may contain text and/or multiple codings, where the codings themselves contain a code and a system.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "SearchParameter.target",
        "short": "Types of resource (if a resource reference)",
        "definition": "Types of resource (if a resource is referenced).",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "ResourceType",
          "strength": "required",
          "description": "One of the resource types defined as part of FHIR",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/resource-types"
          }
        }
      }
    ]
  }
}