extension shown: fhir [x]
Text
Data type: Text.
Usage: Between 1000 and 10,000 domains
- Leave public feedback on this term 💬
- Check for open issues.
- 'Text' is mentioned in layer: core
- 'Text' is mentioned in extension layer: fhir
Instances of Text may appear as values for the following properties
Property | On Types | Description |
---|---|---|
Account.description
|
Account | Provides additional information about what the account tracks and how it is used. |
Account.name
|
Account | Name used for the account when displaying it to humans in reports, etc. |
Account.type
|
Account | Categorizes the account for reporting and searching purposes. |
AllergyIntolerance.reaction.description
|
AllergyIntolerance | Text description about the reaction as a whole, including details of the manifestation if required. |
Appointment.comment
|
Appointment | Additional comments about the appointment. |
Appointment.description
|
Appointment | The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field. |
AppointmentResponse.comment
|
AppointmentResponse | Additional comments about the appointment. |
AuditEvent.event.outcomeDesc
|
AuditEvent | A free text description of the outcome of the event. |
AuditEvent.object.description
|
AuditEvent | Text that describes the object in more detail. |
AuditEvent.object.detail.type
|
AuditEvent | Name of the property. |
AuditEvent.object.name
|
AuditEvent | An instance-specific descriptor of the Participant Object ID audited, such as a person's name. |
AuditEvent.participant.altId
|
AuditEvent | Alternative Participant Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available. |
AuditEvent.participant.name
|
AuditEvent | Human-meaningful name for the user. |
AuditEvent.participant.network.address
|
AuditEvent | An identifier for the network access point of the user device for the audit event. |
AuditEvent.participant.policy
|
AuditEvent | The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. |
AuditEvent.source.site
|
AuditEvent | Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. |
BodySite.description
|
BodySite | Description of anatomical location. |
Bundle.entry.fullUrl
|
Bundle | The Absolute URL for the resource. This must be provided for all resources. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. |
Bundle.entry.request.ifMatch
|
Bundle | Only perform the operation if the Etag value matches. For more information, see the API section ["Managing Resource Contention"](http.html#concurrency). |
Bundle.entry.request.ifNoneExist
|
Bundle | Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for ["Conditional Create"](http.html#ccreate). This is just the query portion of the URL - what follows the "?" (not including the "?"). |
Bundle.entry.request.ifNoneMatch
|
Bundle | If the ETag values match, return a 304 Not modified status. See the API documentation for ["Conditional Read"](http.html#cread). |
Bundle.entry.request.url
|
Bundle | The URL for this entry, relative to the root (the address to which the request is posted). |
Bundle.entry.response.etag
|
Bundle | The etag for the resource, it the operation for the entry produced a versioned resource. |
Bundle.entry.response.location
|
Bundle | The location header created by processing this operation. |
Bundle.entry.response.status
|
Bundle | The status code returned by processing this entry. |
Bundle.link.relation
|
Bundle | A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]]. |
Bundle.link.url
|
Bundle | The reference details for the link. |
CarePlan.activity.detail.description
|
CarePlan | This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc. |
CarePlan.activity.detail.scheduledstring
|
CarePlan | The period, timing or frequency upon which the described activity is to occur. |
CarePlan.description
|
CarePlan | A description of the scope and nature of the plan. |
Claim.coverage.businessArrangement
|
Claim | The contract number of a business agreement which describes the terms and conditions. |
Claim.coverage.preAuthRef
|
Claim | A list of references from the Insurer to which these services pertain. |
Claim.school
|
Claim | Name of school for over-aged dependents. |
ClaimResponse.coverage.businessArrangement
|
ClaimResponse | The contract number of a business agreement which describes the terms and conditions. |
ClaimResponse.coverage.preAuthRef
|
ClaimResponse | A list of references from the Insurer to which these services pertain. |
ClaimResponse.disposition
|
ClaimResponse | A description of the status of the adjudication. |
ClaimResponse.note.text
|
ClaimResponse | The note text. |
ClinicalImpression.description
|
ClinicalImpression | A summary of the context and/or cause of the assessment - why / where was it peformed, and what patient events/sstatus prompted it. |
ClinicalImpression.finding.cause
|
ClinicalImpression | Which investigations support finding or diagnosis. |
ClinicalImpression.prognosis
|
ClinicalImpression | Estimate of likely outcome. |
ClinicalImpression.protocol
|
ClinicalImpression | Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis. |
ClinicalImpression.ruledOut.reason
|
ClinicalImpression | Grounds for elimination. |
ClinicalImpression.summary
|
ClinicalImpression | A text summary of the investigations and the diagnosis. |
Communication.category
|
Communication | The type of message conveyed such as alert, notification, reminder, instruction, etc. |
Communication.payload.contentstring
|
Communication | A communicated content (or for multi-part communications, one portion of the communication). |
Communication.reason
|
Communication | The reason or justification for the communication. |
CommunicationRequest.category
|
CommunicationRequest | The type of message to be sent such as alert, notification, reminder, instruction, etc. |
CommunicationRequest.payload.contentstring
|
CommunicationRequest | The communicated content (or for multi-part communications, one portion of the communication). |
CommunicationRequest.reason
|
CommunicationRequest | The reason or justification for the communication request. |
Composition.section.title
|
measurereport or Composition | The heading for this particular section. This will be part of the rendered content for the document. |
Composition.title
|
measurereport or Composition | Official human-readable label for the composition. |
ConceptMap.contact.name
|
ConceptMap | The name of an individual to contact regarding the concept map. |
ConceptMap.copyright
|
ConceptMap | A copyright statement relating to the concept map and/or its contents. |
ConceptMap.description
|
ConceptMap | A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc. |
ConceptMap.element.code
|
ConceptMap | Identity (code or path) or the element/item being mapped. |
ConceptMap.element.codeSystem
|
ConceptMap | An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system). |
ConceptMap.element.target.code
|
ConceptMap | Identity (code or path) or the element/item that the map refers to. |
ConceptMap.element.target.codeSystem
|
ConceptMap | An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems). |
ConceptMap.element.target.comments
|
ConceptMap | A description of status/issues in mapping that conveys additional information not represented in the structured data. |
ConceptMap.element.target.dependsOn.code
|
ConceptMap | Identity (code or path) or the element/item/ValueSet that the map depends on / refers to. |
ConceptMap.element.target.dependsOn.codeSystem
|
ConceptMap | An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems). |
ConceptMap.element.target.dependsOn.element
|
ConceptMap | A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. HL7 v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition. |
ConceptMap.name
|
ConceptMap | A free text natural language name describing the concept map. |
ConceptMap.publisher
|
ConceptMap | The name of the individual or organization that published the concept map. |
ConceptMap.requirements
|
ConceptMap | Explains why this concept map is needed and why it has been constrained as it has. |
ConceptMap.sourceuri
|
ConceptMap | The source value set that specifies the concepts that are being mapped. |
ConceptMap.targeturi
|
ConceptMap | The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made. |
ConceptMap.url
|
ConceptMap | An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. |
ConceptMap.version
|
ConceptMap | The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. |
Condition.abatementstring
|
Condition | The date or estimated date that the condition resolved or went into remission. This is called "abatement" because of the many overloaded connotations associated with "remission" or "resolution" - Conditions are never really resolved, but they can abate. |
Condition.notes
|
Condition | Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis. |
Condition.onsetstring
|
Condition | Estimated or actual date or date-time the condition began, in the opinion of the clinician. |
Conformance.contact.name
|
Conformance | The name of an individual to contact regarding the conformance. |
Conformance.copyright
|
Conformance | A copyright statement relating to the conformance statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the system described by the conformance statement. |
Conformance.description
|
Conformance | A free text natural language description of the conformance statement and its use. Typically, this is used when the conformance statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP. |
Conformance.document.documentation
|
Conformance | A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc. |
Conformance.fhirVersion
|
Conformance | The version of the FHIR specification on which this conformance statement is based. |
Conformance.implementation.description
|
Conformance | Information about the specific installation that this conformance statement relates to. |
Conformance.implementation.url
|
Conformance | An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. |
Conformance.messaging.documentation
|
Conformance | Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the conformance statement. For example, process for becoming an authorized messaging exchange partner. |
Conformance.messaging.endpoint.address
|
Conformance | The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier. |
Conformance.messaging.event.documentation
|
Conformance | Guidance on how this event is handled, such as internal system trigger points, business rules, etc. |
Conformance.name
|
Conformance | A free text natural language name identifying the conformance statement. |
Conformance.publisher
|
Conformance | The name of the individual or organization that published the conformance. |
Conformance.requirements
|
Conformance | Explains why this conformance statement is needed and why it's been constrained as it has. |
Conformance.rest.compartment
|
Conformance | An absolute URI which is a reference to the definition of a compartment hosted by the system. |
Conformance.rest.documentation
|
Conformance | Information about the system's restful capabilities that apply across all applications, such as security. |
Conformance.rest.interaction.documentation
|
Conformance | Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented. |
Conformance.rest.operation.name
|
Conformance | The name of a query, which is used in the _query parameter when the query is called. |
Conformance.rest.resource.interaction.documentation
|
Conformance | Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'. |
Conformance.rest.resource.searchInclude
|
Conformance | A list of _include values supported by the server. |
Conformance.rest.resource.searchParam.chain
|
Conformance | Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from Conformance.rest.resource.searchParam.name on the target resource type. |
Conformance.rest.resource.searchParam.definition
|
Conformance | An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]). |
Conformance.rest.resource.searchParam.documentation
|
Conformance | This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. |
Conformance.rest.resource.searchParam.name
|
Conformance | The name of the search parameter used in the interface. |
Conformance.rest.resource.searchRevInclude
|
Conformance | A list of _revinclude (reverse include) values supported by the server. |
Conformance.rest.security.description
|
Conformance | General description of how security works. |
Conformance.software.name
|
Conformance | Name software is known by. |
Conformance.software.version
|
Conformance | The version identifier for the software covered by this statement. |
Conformance.url
|
Conformance | An absolute URL that is used to identify this conformance statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this conformance statement is (or will be) published. |
Conformance.version
|
Conformance | The identifier that is used to identify this version of the conformance statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. |
Contract.signer.signature
|
Contract or consentdirective | Legally binding Consent Directive DSIG signature contents in Base64. |
Contract.term.text
|
Contract or consentdirective | Human readable form of this Contract Provision. |
Coverage.group
|
Coverage | Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID. |
Coverage.plan
|
Coverage | Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage or employer group. May also be referred to as a Policy or Group ID. |
Coverage.subPlan
|
Coverage | Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a specific employer group within a class of employers. May be referred to as a Section or Division ID. |
DataElement.contact.name
|
DataElement | The name of an individual to contact regarding the data element. |
DataElement.copyright
|
DataElement | A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element. |
DataElement.mapping.comments
|
DataElement | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
DataElement.mapping.identity
|
DataElement | An internal id that is used to identify this mapping set when specific mappings are made on a per-element basis. |
DataElement.mapping.name
|
DataElement | A name for the specification that is being mapped to. |
DataElement.mapping.uri
|
DataElement | An absolute URI that identifies the specification that this mapping is expressed to. |
DataElement.name
|
DataElement | The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used. |
DataElement.publisher
|
DataElement | The name of the individual or organization that published the data element. |
DataElement.url
|
DataElement | An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. |
DataElement.version
|
DataElement | The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually. |
DetectedIssue.detail
|
DetectedIssue | A textual explanation of the detected issue. |
DetectedIssue.reference
|
DetectedIssue | The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified. |
Device.lotNumber
|
Device | Lot number assigned by the manufacturer. |
Device.manufacturer
|
Device | A name of the manufacturer. |
Device.model
|
Device | The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type. |
Device.udi
|
Device | United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm. |
Device.url
|
Device | A network address on which the device may be contacted directly. |
Device.version
|
Device | The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware. |
DeviceComponent.operationalStatus
|
DeviceComponent | Indicates current operational status of the device. For example: On, Off, Standby, etc. |
DeviceComponent.parameterGroup
|
DeviceComponent | Describes the parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular. |
DeviceComponent.productionSpecification.productionSpec
|
DeviceComponent | Describes the printable string defining the component. |
DeviceComponent.productionSpecification.specType
|
DeviceComponent | Describes the specification type, such as, serial number, part number, hardware revision, software revision, etc. |
DeviceUseRequest.notes
|
DeviceUseRequest | Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
DeviceUseStatement.notes
|
DeviceUseStatement | Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. |
DiagnosticReport.conclusion
|
lipidprofile or DiagnosticReport | May include diagnosis or suggestions for follow up testing. |
DiagnosticReport.image.comment
|
DiagnosticReport | A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer's attention to important features. |
DocumentManifest.description
|
DocumentManifest or xdsdocumentmanifest | Human-readable description of the source document. This is sometimes known as the "title". |
DocumentManifest.source
|
DocumentManifest or xdsdocumentmanifest | Identifies the source system, application, or software that produced the document manifest. |
DocumentReference.description
|
DocumentReference | Human-readable description of the source document. This is sometimes known as the "title". |
EligibilityResponse.disposition
|
EligibilityResponse | A description of the status of the adjudication. |
Encounter.hospitalization.reAdmission
|
Encounter | Whether this hospitalization is a readmission and why if known. |
EnrollmentResponse.disposition
|
EnrollmentResponse | A description of the status of the adjudication. |
EpisodeOfCare.type
|
EpisodeOfCare | A classification of the type of encounter; e.g. specialist referral, disease management, type of funded care. |
ExplanationOfBenefit.disposition
|
ExplanationOfBenefit | A description of the status of the adjudication. |
FamilyMemberHistory.agestring
|
FamilyMemberHistory | The actual or approximate age of the relative at the time the family member history is recorded. |
FamilyMemberHistory.bornstring
|
FamilyMemberHistory | The actual or approximate date of birth of the relative. |
FamilyMemberHistory.condition.onsetstring
|
FamilyMemberHistory | Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence. |
FamilyMemberHistory.deceasedstring
|
FamilyMemberHistory | Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record. |
FamilyMemberHistory.name
|
FamilyMemberHistory | This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair". |
Goal.description
|
Goal | Human-readable description of a specific desired objective of care. |
Goal.outcome.resultCodeableConcept
|
Goal | Details of what's changed (or not changed). |
Group.characteristic.code
|
Group | A code that identifies the kind of trait being asserted. |
Group.characteristic.valueCodeableConcept
|
Group | The value of the trait that holds (or does not hold - see 'exclude') for members of the group. |
Group.code
|
Group | Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc. |
Group.name
|
Group | A label assigned to the group for human identification and communication. |
HealthcareService.availabilityExceptions
|
HealthcareService | A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. |
HealthcareService.characteristic
|
HealthcareService | Collection of characteristics (attributes). |
HealthcareService.comment
|
HealthcareService | Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName. |
HealthcareService.eligibility
|
HealthcareService | Does this service have specific eligibility requirements that need to be met in order to use the service? |
HealthcareService.eligibilityNote
|
HealthcareService | Describes the eligibility conditions for the service. |
HealthcareService.extraDetails
|
HealthcareService | Extra details about the service that can't be placed in the other fields. |
HealthcareService.notAvailable.description
|
HealthcareService | The reason that can be presented to the user as to why this time is not available. |
HealthcareService.programName
|
HealthcareService | Program Names that can be used to categorize the service. |
HealthcareService.publicKey
|
HealthcareService | The public part of the 'keys' allocated to an Organization by an accredited body to support secure exchange of data over the internet. To be provided by the Organization, where available. |
HealthcareService.serviceCategory
|
HealthcareService | Identifies the broad category of service being performed or delivered. |
HealthcareService.serviceName
|
HealthcareService | Further description of the service as it would be presented to a consumer while searching. |
HealthcareService.serviceType.specialty
|
HealthcareService | Collection of specialties handled by the service site. This is more of a medical term. |
ImagingObjectSelection.description
|
ImagingObjectSelection | Text description of the DICOM SOP instances selected in the ImagingObjectSelection. This should be aligned with the content of the title element, and can provide further explanation of the SOP instances in the selection. |
ImagingObjectSelection.study.series.instance.frames.url
|
ImagingObjectSelection | WADO-RS URL to retrieve the DICOM frames. |
ImagingObjectSelection.study.series.instance.sopClass
|
ImagingObjectSelection | SOP class UID of the selected instance. |
ImagingObjectSelection.study.series.instance.uid
|
ImagingObjectSelection | SOP Instance UID of the selected instance. |
ImagingObjectSelection.study.series.instance.url
|
ImagingObjectSelection | WADO-RS URL to retrieve the DICOM SOP Instance. |
ImagingObjectSelection.study.series.uid
|
ImagingObjectSelection | Series instance UID of the SOP instances in the selection. |
ImagingObjectSelection.study.series.url
|
ImagingObjectSelection | WADO-RS URL to retrieve the series. Note that this URL retrieves all SOP instances of the series not only those in the selection. |
ImagingObjectSelection.study.uid
|
ImagingObjectSelection | Study instance UID of the SOP instances in the selection. |
ImagingObjectSelection.study.url
|
ImagingObjectSelection | WADO-RS URL to retrieve the study. Note that this URL retrieves all SOP instances of the study, not only those in the selection. |
ImagingObjectSelection.uid
|
ImagingObjectSelection | Instance UID of the DICOM KOS SOP Instances represented in this resource. |
ImagingStudy.description
|
ImagingStudy | Institution-generated description or classification of the Study performed. |
ImagingStudy.series.description
|
ImagingStudy | A description of the series. |
ImagingStudy.series.instance.sopClass
|
ImagingStudy | DICOM instance type. |
ImagingStudy.series.instance.title
|
ImagingStudy | The description of the instance. |
ImagingStudy.series.instance.type
|
ImagingStudy | A human-friendly SOP Class name. |
ImagingStudy.series.instance.uid
|
ImagingStudy | Formal identifier for this image or other content. |
ImagingStudy.series.uid
|
ImagingStudy | Formal identifier for this series. |
ImagingStudy.series.url
|
ImagingStudy | URI/URL specifying the location of the referenced series using WADO-RS. |
ImagingStudy.uid
|
ImagingStudy | Formal identifier for the study. |
ImagingStudy.url
|
ImagingStudy | WADO-RS resource where Study is available. |
Immunization.lotNumber
|
Immunization | Lot number of the vaccine product. |
Immunization.vaccinationProtocol.description
|
Immunization | Contains the description about the protocol under which the vaccine was administered. |
Immunization.vaccinationProtocol.series
|
Immunization | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
ImmunizationRecommendation.recommendation.protocol.description
|
ImmunizationRecommendation | Contains the description about the protocol under which the vaccine was administered. |
ImmunizationRecommendation.recommendation.protocol.series
|
ImmunizationRecommendation | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
ImplementationGuide.binary
|
ImplementationGuide | A binary file that is included in the implementation guide when it is published. |
ImplementationGuide.contact.name
|
ImplementationGuide | The name of an individual to contact regarding the implementation guide. |
ImplementationGuide.copyright
|
ImplementationGuide | A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings. |
ImplementationGuide.dependency.uri
|
ImplementationGuide | Where the dependency is located. |
ImplementationGuide.description
|
ImplementationGuide | A free text natural language description of the Implementation Guide and its use. |
ImplementationGuide.fhirVersion
|
ImplementationGuide | The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version. |
ImplementationGuide.name
|
ImplementationGuide | A free text natural language name identifying the Implementation Guide. |
ImplementationGuide.package.description
|
ImplementationGuide | Human readable text describing the package. |
ImplementationGuide.package.name
|
ImplementationGuide | The name for the group, as used in page.package. |
ImplementationGuide.package.resource.acronym
|
ImplementationGuide | A short code that may be used to identify the resource throughout the implementation guide. |
ImplementationGuide.package.resource.description
|
ImplementationGuide | A description of the reason that a resource has been included in the implementation guide. |
ImplementationGuide.package.resource.name
|
ImplementationGuide | A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name). |
ImplementationGuide.package.resource.sourceuri
|
ImplementationGuide | Where this resource is found. |
ImplementationGuide.page.name
|
ImplementationGuide | A short name used to represent this page in navigational structures such as table of contents, bread crumbs, etc. |
ImplementationGuide.page.package
|
ImplementationGuide | For constructed pages, a list of packages to include in the page (or else empty for everything). |
ImplementationGuide.page.source
|
ImplementationGuide | The source address for the page. |
ImplementationGuide.publisher
|
ImplementationGuide | The name of the individual or organization that published the implementation guide. |
ImplementationGuide.url
|
ImplementationGuide | An absolute URL that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. |
ImplementationGuide.version
|
ImplementationGuide | The identifier that is used to identify this version of the Implementation Guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Implementation Guide author manually. |
List.note
|
List | Comments that apply to the overall list. |
List.title
|
List | A label for the list assigned by the author. |
Location.description
|
Location | Description of the Location, which helps in finding or referencing the place. |
Location.name
|
Location | Name of the location as used by humans. Does not need to be unique. |
Media.deviceName
|
Media | The name of the device / manufacturer of the device that was used to make the recording. |
Medication.product.batch.lotNumber
|
Medication | The assigned lot number of a batch of the specified product. |
MedicationAdministration.dosage.method
|
MedicationAdministration | A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. |
MedicationAdministration.dosage.text
|
MedicationAdministration | Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. |
MedicationAdministration.note
|
MedicationAdministration | Extra information about the medication administration that is not conveyed by the other attributes. |
MedicationDispense.dosageInstruction.additionalInstructions
|
MedicationDispense | Additional instructions such as "Swallow with plenty of water" which may or may not be coded. |
MedicationDispense.dosageInstruction.asNeededCodeableConcept
|
MedicationDispense | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule. |
MedicationDispense.dosageInstruction.method
|
MedicationDispense | A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. |
MedicationDispense.dosageInstruction.text
|
MedicationDispense | Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. |
MedicationDispense.note
|
MedicationDispense | Extra information about the dispense that could not be conveyed in the other attributes. |
MedicationOrder.dosageInstruction.additionalInstructions
|
MedicationOrder | Additional instructions such as "Swallow with plenty of water" which may or may not be coded. |
MedicationOrder.dosageInstruction.asNeededCodeableConcept
|
MedicationOrder | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). |
MedicationOrder.dosageInstruction.method
|
MedicationOrder | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. |
MedicationOrder.dosageInstruction.text
|
MedicationOrder | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. |
MedicationOrder.note
|
MedicationOrder | Extra information about the prescription that could not be conveyed by the other attributes. |
MedicationOrder.reasonEnded
|
MedicationOrder | The reason why the prescription was stopped, if it was. |
MedicationStatement.dosage.asNeededCodeableConcept
|
MedicationStatement | Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). Specifically if 'boolean' datatype is selected, then the following logic applies: If set to True, this indicates that the medication is only taken when needed, within the specified schedule. |
MedicationStatement.dosage.method
|
MedicationStatement | A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV. |
MedicationStatement.dosage.text
|
MedicationStatement | Free text dosage information as reported about a patient's medication use. When coded dosage information is present, the free text may still be present for display to humans. |
MedicationStatement.note
|
MedicationStatement | Provides extra information about the medication statement that is not conveyed by the other attributes. |
MessageHeader.destination.endpoint
|
MessageHeader | Indicates where the message should be routed to. |
MessageHeader.destination.name
|
MessageHeader | Human-readable name for the target system. |
MessageHeader.response.identifier
|
MessageHeader | The id of the message that this message is a response to. |
MessageHeader.source.endpoint
|
MessageHeader | Identifies the routing target to send acknowledgements to. |
MessageHeader.source.name
|
MessageHeader | Human-readable name for the source system. |
MessageHeader.source.software
|
MessageHeader | May include configuration or other information useful in debugging. |
MessageHeader.source.version
|
MessageHeader | Can convey versions of multiple systems in situations where a message passes through multiple hands. |
NamingSystem.contact.name
|
NamingSystem | The name of an individual to contact regarding the naming system. |
NamingSystem.description
|
NamingSystem | Details about what the namespace identifies including scope, granularity, version labeling, etc. |
NamingSystem.name
|
NamingSystem | The descriptive name of this particular identifier type or code system. |
NamingSystem.publisher
|
NamingSystem | The name of the individual or organization that published the naming system. |
NamingSystem.responsible
|
NamingSystem | The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. |
NamingSystem.uniqueId.value
|
NamingSystem | The string that should be sent over the wire to identify the code system or identifier system. |
NamingSystem.usage
|
NamingSystem | Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. |
NutritionOrder.enteralFormula.additiveProductName
|
NutritionOrder | The product or brand name of the type of modular component to be added to the formula. |
NutritionOrder.enteralFormula.administrationInstruction
|
NutritionOrder | Free text formula administration, feeding instructions or additional instructions or information. |
NutritionOrder.enteralFormula.baseFormulaProductName
|
NutritionOrder | The product or brand name of the enteral or infant formula product such as "ACME Adult Standard Formula". |
NutritionOrder.oralDiet.instruction
|
NutritionOrder | Free text or additional instructions or information pertaining to the oral diet. |
NutritionOrder.supplement.instruction
|
NutritionOrder | Free text or additional instructions or information pertaining to the oral supplement. |
NutritionOrder.supplement.productName
|
NutritionOrder | The product or brand name of the nutritional supplement such as "Acme Protein Shake". |
Observation.comments
|
triglyceride or devicemetricobservation or hdlcholesterol or cholesterol or ldlcholesterol or Observation | May include statements about significant, unexpected or unreliable. values, or information about the source of the value where this may be relevant to the interpretation of the result. |
Observation.component.valuestring
|
Observation | The information determined as a result of making the observation, if the information has a simple value. |
Observation.referenceRange.text
|
Observation | Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of "Negative" or a list or table of 'normals'. |
Observation.valueQuantity.code
|
cholesterol | A computer processable form of the unit in some unit representation system. |
Observation.valueQuantity.system
|
cholesterol | The identification of the system that provides the coded form of the unit. |
Observation.valueQuantity.unit
|
cholesterol | A human-readable form of the unit. |
Observation.valuestring
|
devicemetricobservation or Observation | The information determined as a result of making the observation, if the information has a simple value. |
OperationDefinition.code
|
OperationDefinition | The name used to invoke the operation. |
OperationDefinition.contact.name
|
OperationDefinition | The name of an individual to contact regarding the operation definition. |
OperationDefinition.description
|
OperationDefinition | A free text natural language description of the profile and its use. |
OperationDefinition.name
|
OperationDefinition | A free text natural language name identifying the operation. |
OperationDefinition.notes
|
OperationDefinition | Additional information about how to use this operation or named query. |
OperationDefinition.parameter.binding.valueSeturi
|
OperationDefinition | Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. |
OperationDefinition.parameter.documentation
|
OperationDefinition | Describes the meaning or use of this parameter. |
OperationDefinition.parameter.max
|
OperationDefinition | The maximum number of times this element is permitted to appear in the request or response. |
OperationDefinition.parameter.name
|
OperationDefinition | The name of used to identify the parameter. |
OperationDefinition.publisher
|
OperationDefinition | The name of the individual or organization that published the operation definition. |
OperationDefinition.requirements
|
OperationDefinition | Explains why this operation definition is needed and why it's been constrained as it has. |
OperationDefinition.url
|
OperationDefinition | An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. |
OperationDefinition.version
|
OperationDefinition | The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. |
OperationOutcome.issue.diagnostics
|
OperationOutcome | Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue. |
OperationOutcome.issue.location
|
OperationOutcome | A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. |
Order.reasonCodeableConcept
|
Order | Text - why the order was made. |
Order.when.code
|
Order | Code specifies when request should be done. The code may simply be a priority code. |
OrderResponse.description
|
OrderResponse | Additional description about the response - e.g. a text description provided by a human user when making decisions about the order. |
Organization.name
|
Organization | A name associated with the organization. |
Parameters.parameter.name
|
Parameters | The name of the parameter (reference to the operation definition). |
Parameters.parameter.valuecode
|
Parameters | If the parameter is a data type. |
Parameters.parameter.valueid
|
Parameters | If the parameter is a data type. |
Parameters.parameter.valuemarkdown
|
Parameters | If the parameter is a data type. |
Parameters.parameter.valueoid
|
Parameters | If the parameter is a data type. |
Parameters.parameter.valuestring
|
Parameters | If the parameter is a data type. |
Parameters.parameter.valueuri
|
Parameters | If the parameter is a data type. |
PaymentReconciliation.disposition
|
PaymentReconciliation | A description of the status of the adjudication. |
PaymentReconciliation.note.text
|
PaymentReconciliation | The note text. |
ProcedureRequest.asNeededCodeableConcept
|
ProcedureRequest | If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. |
ProcessRequest.exclude
|
ProcessRequest | Names of resource types to exclude. |
ProcessRequest.include
|
ProcessRequest | Names of resource types to include. |
ProcessRequest.reference
|
ProcessRequest | A reference to supply which authenticates the process. |
ProcessResponse.disposition
|
ProcessResponse | A description of the status of the adjudication or processing. |
ProcessResponse.notes.text
|
ProcessResponse | The note text. |
Provenance.agent.relatedAgent.target
|
Provenance | An internal reference to another agent listed in this provenance by its identifier. |
Provenance.entity.display
|
Provenance | Human-readable description of the entity. |
Provenance.entity.reference
|
Provenance | Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. |
Provenance.policy
|
Provenance | Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. |
Questionnaire.group.linkId
|
Questionnaire | An identifier that is unique within the Questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource. |
Questionnaire.group.question.linkId
|
Questionnaire | An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resource. |
Questionnaire.group.question.text
|
Questionnaire | The actual question as shown to the user to prompt them for an answer. |
Questionnaire.group.text
|
Questionnaire | Additional text for the group, used for display purposes. |
Questionnaire.group.title
|
Questionnaire | The human-readable name for this section of the questionnaire. |
Questionnaire.publisher
|
Questionnaire | Organization or person responsible for developing and maintaining the questionnaire. |
Questionnaire.version
|
Questionnaire | The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated. |
QuestionnaireResponse.group.linkId
|
QuestionnaireResponse | Identifies the group from the Questionnaire that corresponds to this group in the QuestionnaireResponse resource. |
QuestionnaireResponse.group.question.answer.valuestring
|
QuestionnaireResponse | The answer (or one of the answers) provided by the respondent to the question. |
QuestionnaireResponse.group.question.answer.valueuri
|
QuestionnaireResponse | The answer (or one of the answers) provided by the respondent to the question. |
QuestionnaireResponse.group.question.linkId
|
QuestionnaireResponse | Identifies the question from the Questionnaire that corresponds to this question in the QuestionnaireResponse resource. |
QuestionnaireResponse.group.question.text
|
QuestionnaireResponse | The actual question as shown to the user to prompt them for an answer. |
QuestionnaireResponse.group.text
|
QuestionnaireResponse | Additional text for the group, used for display purposes. |
QuestionnaireResponse.group.title
|
QuestionnaireResponse | Text that is displayed above the contents of the group. |
ReferralRequest.description
|
ReferralRequest | The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary. |
ReferralRequest.reason
|
ReferralRequest | Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management. |
ReferralRequest.type
|
ReferralRequest | An indication of the type of referral (or where applicable the type of transfer of care) request. |
Resource.id
|
Resource | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Resource.implicitRules
|
Resource | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
RiskAssessment.method
|
RiskAssessment | The algorithm, process or mechanism used to evaluate the risk. |
RiskAssessment.mitigation
|
RiskAssessment | A description of the steps that might be taken to reduce the identified risk(s). |
RiskAssessment.prediction.outcome
|
RiskAssessment | One of the potential outcomes for the patient (e.g. remission, death, a particular condition). |
RiskAssessment.prediction.rationale
|
RiskAssessment | Additional information explaining the basis for the prediction. |
Schedule.comment
|
Schedule | Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated. |
SearchParameter.code
|
SearchParameter | The code used in the URL or the parameter name in a parameters resource for this search parameter. |
SearchParameter.contact.name
|
SearchParameter | The name of an individual to contact regarding the search parameter. |
SearchParameter.description
|
SearchParameter | A description of the search parameters and how it used. |
SearchParameter.name
|
SearchParameter | A free text natural language name identifying the search parameter. |
SearchParameter.publisher
|
SearchParameter | The name of the individual or organization that published the search parameter. |
SearchParameter.requirements
|
SearchParameter | The Scope and Usage that this search parameter was created to meet. |
SearchParameter.url
|
SearchParameter | An absolute URL that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. |
SearchParameter.xpath
|
SearchParameter | An XPath expression that returns a set of elements for the search parameter. |
Slot.comment
|
Slot | Comments on the slot to describe any extended information. Such as custom constraints on the slot. |
Specimen.collection.comment
|
Specimen | To communicate any details or issues encountered during the specimen collection procedure. |
Specimen.container.description
|
Specimen | Textual description of the container. |
Specimen.treatment.description
|
Specimen | Textual description of procedure. |
StructureDefinition.base
|
StructureDefinition | An absolute URI that is the base structure from which this set of constraints is derived. |
StructureDefinition.contact.name
|
StructureDefinition | The name of an individual to contact regarding the structure definition. |
StructureDefinition.context
|
StructureDefinition | Identifies the types of resource or data type elements to which the extension can be applied. |
StructureDefinition.copyright
|
StructureDefinition | A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings. |
StructureDefinition.description
|
StructureDefinition | A free text natural language description of the StructureDefinition and its use. |
StructureDefinition.display
|
StructureDefinition | Defined so that applications can use this name when displaying the value of the extension to the user. |
StructureDefinition.fhirVersion
|
StructureDefinition | The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 1.0.2 for this version. |
StructureDefinition.mapping.comments
|
StructureDefinition | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
StructureDefinition.mapping.identity
|
StructureDefinition | An Internal id that is used to identify this mapping set when specific mappings are made. |
StructureDefinition.mapping.name
|
StructureDefinition | A name for the specification that is being mapped to. |
StructureDefinition.mapping.uri
|
StructureDefinition | An absolute URI that identifies the specification that this mapping is expressed to. |
StructureDefinition.name
|
StructureDefinition | A free text natural language name identifying the StructureDefinition. |
StructureDefinition.publisher
|
StructureDefinition | The name of the individual or organization that published the structure definition. |
StructureDefinition.requirements
|
StructureDefinition | Explains why this structure definition is needed and why it's been constrained as it has. |
StructureDefinition.url
|
StructureDefinition | An absolute URL that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. |
StructureDefinition.version
|
StructureDefinition | The identifier that is used to identify this version of the StructureDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the StructureDefinition author manually. |
Subscription.channel.endpoint
|
Subscription | The uri that describes the actual end-point to send messages to. |
Subscription.channel.header
|
Subscription | Additional headers / information to send as part of the notification. |
Subscription.channel.payload
|
Subscription | The mime type to send the payload in - either application/xml+fhir, or application/json+fhir. If the mime type is blank, then there is no payload in the notification, just a notification. |
Subscription.criteria
|
Subscription | The rules that the server should use to determine when to generate notifications for this subscription. |
Subscription.error
|
Subscription | A record of the last error that occurred when the server processed a notification. |
Subscription.reason
|
Subscription | A description of why this subscription is defined. |
Substance.description
|
Substance | A description of the substance - its appearance, handling requirements, and other usage notes. |
TestScript.contact.name
|
TestScript | The name of an individual to contact regarding the Test Script. |
TestScript.copyright
|
TestScript | A copyright statement relating to the Test Script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the details of the constraints and mappings. |
TestScript.description
|
TestScript | A free text natural language description of the TestScript and its use. |
TestScript.metadata.capability.description
|
TestScript | Description of the capabilities that this test script is requiring the server to support. |
TestScript.metadata.capability.link
|
TestScript | Links to the FHIR specification that describes this interaction and the resources involved in more detail. |
TestScript.metadata.link.description
|
TestScript | Short description of the link. |
TestScript.metadata.link.url
|
TestScript | URL to a particular requirement or feature within the FHIR specification. |
TestScript.name
|
TestScript | A free text natural language name identifying the TestScript. |
TestScript.publisher
|
TestScript | The name of the individual or organization that published the Test Script. |
TestScript.requirements
|
TestScript | Explains why this Test Script is needed and why it's been constrained as it has. |
TestScript.setup.action.assert.compareToSourceId
|
TestScript | Id of fixture used to compare the "sourceId/path" evaluations to. |
TestScript.setup.action.assert.compareToSourcePath
|
TestScript | XPath or JSONPath expression against fixture used to compare the "sourceId/path" evaluations to. |
TestScript.setup.action.assert.description
|
TestScript | The description would be used by test engines for tracking and reporting purposes. |
TestScript.setup.action.assert.headerField
|
TestScript | The HTTP header field name e.g. 'Location'. |
TestScript.setup.action.assert.label
|
TestScript | The label would be used for tracking/logging purposes by test engines. |
TestScript.setup.action.assert.minimumId
|
TestScript | The ID of a fixture. Asserts that the response contains at a minimumId the fixture specified by minimumId. |
TestScript.setup.action.assert.path
|
TestScript | The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server. |
TestScript.setup.action.assert.responseCode
|
TestScript | The value of the HTTP response code to be tested. |
TestScript.setup.action.assert.sourceId
|
TestScript | Fixture to evaluate the XPath/JSONPath expression or the headerField against. |
TestScript.setup.action.assert.validateProfileId
|
TestScript | The ID of the Profile to validate against. |
TestScript.setup.action.assert.value
|
TestScript | The value to compare to. |
TestScript.setup.action.operation.description
|
TestScript | The description would be used by test engines for tracking and reporting purposes. |
TestScript.setup.action.operation.label
|
TestScript | The label would be used for tracking/logging purposes by test engines. |
TestScript.setup.action.operation.params
|
TestScript | Path plus parameters after [type]. Used to set parts of the request URL explicitly. |
TestScript.setup.action.operation.requestHeader.field
|
TestScript | The HTTP header field e.g. "Accept". |
TestScript.setup.action.operation.requestHeader.value
|
TestScript | The value of the header e.g. "application/xml". |
TestScript.setup.action.operation.responseId
|
TestScript | The fixture id (maybe new) to map to the response. |
TestScript.setup.action.operation.sourceId
|
TestScript | The id of the fixture used as the body of a PUT or POST request. |
TestScript.setup.action.operation.targetId
|
TestScript | Id of fixture used for extracting the [id], [type], and [vid] for GET requests. |
TestScript.setup.action.operation.url
|
TestScript | Complete request URL. |
TestScript.test.description
|
TestScript | A short description of the test used by test engines for tracking and reporting purposes. |
TestScript.test.name
|
TestScript | The name of this test used for tracking/logging purposes by test engines. |
TestScript.url
|
TestScript | An absolute URL that is used to identify this Test Script. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Test Script is (or will be) published. |
TestScript.variable.headerField
|
TestScript | Will be used to grab the HTTP header field value from the headers that sourceId is pointing to. |
TestScript.variable.name
|
TestScript | Descriptive name for this variable. |
TestScript.variable.path
|
TestScript | XPath or JSONPath against the fixture body. When variables are defined, either headerField must be specified or path, but not both. |
TestScript.variable.sourceId
|
TestScript | Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable. |
TestScript.version
|
TestScript | The identifier that is used to identify this version of the TestScript. This is an arbitrary value managed by the TestScript author manually. |
ValueSet.codeSystem.concept.code
|
shareablevalueset or ValueSet | A code - a text symbol - that uniquely identifies the concept within the code system. |
ValueSet.codeSystem.concept.definition
|
shareablevalueset or ValueSet | The formal definition of the concept. The value set resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept. |
ValueSet.codeSystem.concept.designation.value
|
ValueSet | The text value for this designation. |
ValueSet.codeSystem.concept.display
|
shareablevalueset or ValueSet | A human readable string that is the recommended default way to present this concept to a user. |
ValueSet.codeSystem.system
|
shareablevalueset or ValueSet | An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system. |
ValueSet.codeSystem.version
|
shareablevalueset or ValueSet | The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked. |
ValueSet.compose.import
|
ValueSet | Includes the contents of the referenced value set as a part of the contents of this value set. This is an absolute URI that is a reference to ValueSet.uri. |
ValueSet.compose.include.concept.code
|
ValueSet | Specifies a code for the concept to be included or excluded. |
ValueSet.compose.include.concept.display
|
ValueSet | The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system. |
ValueSet.compose.include.filter.property
|
ValueSet | A code that identifies a property defined in the code system. |
ValueSet.compose.include.filter.value
|
ValueSet | The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value. |
ValueSet.compose.include.system
|
ValueSet | An absolute URI which is the code system from which the selected codes come from. |
ValueSet.compose.include.version
|
ValueSet | The version of the code system that the codes are selected from. |
ValueSet.contact.name
|
ValueSet | The name of an individual to contact regarding the value set. |
ValueSet.copyright
|
ValueSet | A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set. |
ValueSet.description
|
shareablevalueset or ValueSet | A free text natural language description of the use of the value set - reason for definition, "the semantic space" to be included in the value set, conditions of use, etc. The description may include a list of expected usages for the value set and can also describe the approach taken to build the value set. |
ValueSet.expansion.contains.code
|
ValueSet | The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set. |
ValueSet.expansion.contains.display
|
ValueSet | The recommended display for this item in the expansion. |
ValueSet.expansion.contains.system
|
ValueSet | An absolute URI which is the code system in which the code for this item in the expansion is defined. |
ValueSet.expansion.contains.version
|
ValueSet | The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence. |
ValueSet.expansion.identifier
|
ValueSet | An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so. |
ValueSet.expansion.parameter.name
|
ValueSet | The name of the parameter. |
ValueSet.expansion.parameter.valuecode
|
ValueSet | The value of the parameter. |
ValueSet.expansion.parameter.valuestring
|
ValueSet | The value of the parameter. |
ValueSet.expansion.parameter.valueuri
|
ValueSet | The value of the parameter. |
ValueSet.name
|
shareablevalueset or ValueSet | A free text natural language name describing the value set. |
ValueSet.publisher
|
shareablevalueset or ValueSet | The name of the individual or organization that published the value set. |
ValueSet.requirements
|
ValueSet | Explains why this value set is needed and why it has been constrained as it has. |
ValueSet.url
|
shareablevalueset or ValueSet | An absolute URL that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. |
ValueSet.version
|
shareablevalueset or ValueSet | Used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. |
VisionPrescription.dispense.brand
|
VisionPrescription | Brand recommendations or restrictions. |
VisionPrescription.dispense.color
|
VisionPrescription | Special color or pattern. |
VisionPrescription.dispense.notes
|
VisionPrescription | Notes for special requirements such as coatings and lens materials. |
acceptsReservations
|
FoodEstablishment | Indicates whether a FoodEstablishment accepts reservations. Values can be Boolean, an URL at which reservations can be made or (for backwards compatibility) the strings Yes or No . |
accessCode
|
DeliveryEvent | Password, PIN, or access code needed for delivery (e.g. from a locker). |
accessibilityAPI
|
CreativeWork | Indicates that the resource is compatible with the referenced accessibility API (WebSchemas wiki lists possible values). |
accessibilityControl
|
CreativeWork | Identifies input methods that are sufficient to fully control the described resource (WebSchemas wiki lists possible values). |
accessibilityFeature
|
CreativeWork | Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility (WebSchemas wiki lists possible values). |
accessibilityHazard
|
CreativeWork | A characteristic of the described resource that is physiologically dangerous to some users. Related to WCAG 2.0 guideline 2.3 (WebSchemas wiki lists possible values). |
accountId
|
Invoice | The identifier for the account the payment will be applied to. |
actionOption
|
ChooseAction | A sub property of object. The options subject to this action. Supersedes option. |
actionPlatform
|
EntryPoint | The high level platform(s) where the Action can be performed for the given URL. To specify a specific application or operating system instance, use actionApplication. |
activityFrequency
|
ExercisePlan | How often one should engage in the activity. |
additionalName
|
Person | An additional name for a Person, can be used for a middle name. |
additionalVariable
|
ExercisePlan | Any additional component of the exercise prescription that may need to be articulated to the patient. This may include the order of exercises, the number of repetitions of movement, quantitative distance, progressions over time, etc. |
address
|
Person or GeoCoordinates or Organization or GeoShape or Place | Physical address of the item. |
addressCountry
|
GeoCoordinates or PostalAddress or GeoShape | The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
addressLocality
|
PostalAddress | The locality. For example, Mountain View. |
addressRegion
|
PostalAddress | The region. For example, CA. |
aircraft
|
Flight | The kind of aircraft (e.g., "Boeing 747"). |
alignmentType
|
AlignmentObject | A category of alignment between the learning resource and the framework node. Recommended values include: 'assesses', 'teaches', 'requires', 'textComplexity', 'readingLevel', 'educationalSubject', and 'educationLevel'. |
alternateName
|
Thing | An alias for the item. |
alternativeHeadline
|
CreativeWork | A secondary title of the CreativeWork. |
applicationCategory
|
SoftwareApplication | Type of software application, e.g. "Game, Multimedia". |
applicationSubCategory
|
SoftwareApplication | Subcategory of the application, e.g. "Arcade Game". |
applicationSuite
|
SoftwareApplication | The name of the application suite to which the application belongs (e.g. Excel belongs to Office). |
areaServed
|
Organization or ContactPoint or Offer or Demand or DeliveryChargeSpecification or Service | The geographic area where a service or offered item is provided. Supersedes serviceArea. |
arrivalGate
|
Flight | Identifier of the flight's arrival gate. |
arrivalPlatform
|
TrainTrip | The platform where the train arrives. |
arrivalTerminal
|
Flight | Identifier of the flight's arrival terminal. |
artEdition
|
VisualArtwork | The number of copies when multiple copies of a piece of artwork are produced - e.g. for a limited edition of 20 prints, 'artEdition' refers to the total number of copies (in this example "20"). |
artMedium
|
VisualArtwork | The material used. (e.g. Oil, Watercolour, Acrylic, Linoprint, Marble, Cyanotype, Digital, Lithograph, DryPoint, Intaglio, Pastel, Woodcut, Pencil, Mixed Media, etc.) Supersedes material. |
artform
|
VisualArtwork | e.g. Painting, Drawing, Sculpture, Print, Photograph, Assemblage, Collage, etc. |
articleBody
|
Article | The actual body of the article. |
articleSection
|
Article | Articles may belong to one or more 'sections' in a magazine or newspaper, such as Sports, Lifestyle, etc. |
artworkSurface
|
VisualArtwork | The supporting materials for the artwork, e.g. Canvas, Paper, Wood, Board, etc. Supersedes surface. |
assemblyVersion
|
APIReference | Associated product/technology version. e.g., .NET Framework 4.5. |
audienceType
|
Audience | The target group associated with a given audience (e.g. veterans, car owners, musicians, etc.). |
availableOnDevice
|
SoftwareApplication | Device required to run the application. Used in cases where a specific make/model is required to run the application. Supersedes device. |
award
|
Person or Organization or CreativeWork or Product or Service | An award won by or for this item. Supersedes awards. |
bestRating
|
Rating | The highest value allowed in this rating system. If bestRating is omitted, 5 is assumed. |
bitrate
|
MediaObject | The bitrate of the media object. |
boardingGroup
|
FlightReservation | The airline-specific indicator of boarding order / preference. |
bookEdition
|
Book | The edition of the book. |
box
|
GeoShape | A box is the area enclosed by the rectangle formed by two points. The first point is the lower corner, the second point is the upper corner. A box is expressed as two points separated by a space character. |
branchCode
|
Place | A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.
For example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. |
breadcrumb
|
WebPage | A set of links that can help a user understand and navigate a website hierarchy. |
broadcastChannelId
|
BroadcastChannel | The unique address by which the BroadcastService can be identified in a provider lineup. In US, this is typically a number. |
broadcastDisplayName
|
BroadcastService | The name displayed in the channel guide. For many US affiliates, it is the network name. |
broadcastServiceTier
|
BroadcastChannel | The type of service required to have access to the channel (e.g. Standard or Premium). |
broadcastTimezone
|
BroadcastService | The timezone in ISO 8601 format for which the service bases its broadcasts. |
browserRequirements
|
WebApplication | Specifies browser requirements in human-readable text. For example,"requires HTML5 support". |
busName
|
BusTrip | The name of the bus (e.g. Bolt Express). |
busNumber
|
BusTrip | The unique identifier for the bus. |
caption
|
ImageObject or VideoObject | The caption for this object. |
carrierRequirements
|
MobileApplication | Specifies specific carrier(s) requirements for the application (e.g. an application may only work on a specific carrier network). |
catalogNumber
|
MusicRelease | The catalog number for the release. |
category
|
Product or PhysicalActivity or Invoice or Service or Offer | A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. |
characterName
|
PerformanceRole | The name of a character played in some acting or performing role, i.e. in a PerformanceRole. |
circle
|
GeoShape | A circle is the circular region of a specified radius centered at a specified latitude and longitude. A circle is expressed as a pair followed by a radius in meters. |
citation
|
CreativeWork | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. |
clipNumber
|
Clip | Position of the clip within an ordered group of clips. |
codeSampleType
|
SoftwareSourceCode | Full (compile ready) solution, code snippet, inline code, scripts, template. Supersedes sampleType. |
color
|
Product | The color of the product. |
commentText
|
UserComments | The text of the UserComment. |
confirmationNumber
|
Order or Invoice | A number that confirms the given order or payment has been received. |
contactType
|
ContactPoint | A person or organization can have different contact points, for different purposes. For example, a sales contact point, a PR contact point and so on. This property is used to specify the kind of contact point. |
contentRating
|
CreativeWork | Official rating of a piece of content—for example,'MPAA PG-13'. |
contentSize
|
MediaObject | File size in (mega/kilo) bytes. |
contentType
|
EntryPoint | The supported content type(s) for an EntryPoint response. |
cookingMethod
|
Recipe | The method of cooking, such as Frying, Steaming, ... |
countriesNotSupported
|
SoftwareApplication | Countries for which the application is not supported. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
countriesSupported
|
SoftwareApplication | Countries for which the application is supported. You can also provide the two-letter ISO 3166-1 alpha-2 country code. |
currenciesAccepted
|
LocalBusiness | The currency accepted (in ISO 4217 currency format). |
currency
|
DatedMoneySpecification | The currency in which the monetary amount is expressed (in 3-letter ISO 4217 format). |
dataFeedElement
|
DataFeed | An item within in a data feed. Data feeds may have many elements. |
dateline
|
NewsArticle | The location where the NewsArticle was produced. |
defaultValue
|
PropertyValueSpecification | The default value of the input. For properties that expect a literal, the default is a literal value, for properties that expect an object, it's an ID reference to one of the current values. |
departureGate
|
Flight | Identifier of the flight's departure gate. |
departurePlatform
|
TrainTrip | The platform from which the train departs. |
departureTerminal
|
Flight | Identifier of the flight's departure terminal. |
dependencies
|
TechArticle | Prerequisites needed to fulfill steps in article. |
description
|
Thing | A description of the item. |
disambiguatingDescription
|
Thing | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. |
discount
|
Order | Any discount applied (to an Order). |
discountCode
|
Order | Code used to redeem a discount. |
discountCurrency
|
Order | The currency (in 3-letter ISO 4217 format) of the discount. |
driveWheelConfiguration
|
Vehicle | The drive wheel configuration, i.e. which roadwheels will receive torque from the vehicle's engine via the drivetrain. |
duns
|
Person or Organization | The Dun & Bradstreet DUNS number for identifying an organization or business person. |
educationRequirements
|
JobPosting | Educational background needed for the position. |
educationalFramework
|
AlignmentObject | The framework to which the resource being described is aligned. |
educationalRole
|
EducationalAudience | An educationalRole of an EducationalAudience. |
educationalUse
|
CreativeWork | The purpose of a work in the context of education; for example, 'assignment', 'group work'. |
elevation
|
GeoCoordinates or GeoShape | The elevation of a location (WGS 84). |
eligibleRegion
|
Demand or DeliveryChargeSpecification or Offer | The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.
See also ineligibleRegion. |
email
|
Person or Organization or ContactPoint | Email address. |
employmentType
|
JobPosting | Type of employment (e.g. full-time, part-time, contract, temporary, seasonal, internship). |
encodingFormat
|
MediaObject | mp3, mpeg4, etc. |
encodingType
|
EntryPoint | The supported encoding type(s) for an EntryPoint request. |
episodeNumber
|
Episode | Position of the episode within an ordered group of episodes. |
estimatedFlightDuration
|
Flight | The estimated time the flight will take. |
executableLibraryName
|
APIReference | Library file name e.g., mscorlib.dll, system.web.dll. Supersedes assembly. |
exerciseType
|
ExercisePlan or ExerciseAction | Type(s) of exercise or activity, such as strength training, flexibility training, aerobics, cardiac rehabilitation, etc. |
exifData
|
ImageObject | exif data for this object. |
experienceRequirements
|
JobPosting | Description of skills and experience needed for the position. |
familyName
|
Person | Family name. In the U.S., the last name of an Person. This can be used along with givenName instead of the name property. |
faxNumber
|
Person or Organization or ContactPoint or Place | The fax number. |
featureList
|
SoftwareApplication | Features or modules provided by this application (and possibly required by other applications). |
fileFormat
|
CreativeWork | Media type (aka MIME format, see IANA site) of the content e.g. application/zip of a SoftwareApplication binary. In cases where a CreativeWork has several media type representations, 'encoding' can be used to indicate each MediaObject alongside particular fileFormat information. |
fileSize
|
SoftwareApplication | Size of the application / package (e.g. 18MB). In the absence of a unit (MB, KB etc.), KB will be assumed. |
flightDistance
|
Flight | The distance of the flight. |
flightNumber
|
Flight | The unique identifier for a flight including the airline IATA code. For example, if describing United flight 110, where the IATA code for United is 'UA', the flightNumber is 'UA110'. |
fuelType
|
EngineSpecification or Vehicle | The type of fuel suitable for the engine or engines of the vehicle. If the vehicle has only one engine, this property can be attached directly to the vehicle. |
gamePlatform
|
VideoGameSeries or VideoGame | The electronic systems used to play video games. |
gender
|
Person | Gender of the person. |
genre
|
CreativeWork or MusicGroup | Genre of the creative work or group. |
geoRadius
|
GeoCircle | Indicates the approximate radius of a GeoCircle (metres unless indicated otherwise via Distance notation). |
givenName
|
Person | Given name. In the U.S., the first name of a Person. This can be used along with familyName instead of the name property. |
globalLocationNumber
|
Person or Organization or Place | The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
gtin12
|
Demand or Product or Offer | The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details. |
gtin13
|
Demand or Product or Offer | The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceeding zero. See GS1 GTIN Summary for more details. |
gtin14
|
Demand or Product or Offer | The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details. |
gtin8
|
Demand or Product or Offer | The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details. |
headline
|
CreativeWork | Headline of the article. |
highPrice
|
AggregateOffer | The highest price of all offers available. |
honorificPrefix
|
Person | An honorific prefix preceding a Person's name such as Dr/Mrs/Mr. |
honorificSuffix
|
Person | An honorific suffix preceding a Person's name such as M.D. /PhD/MSCSW. |
httpMethod
|
EntryPoint | An HTTP method that specifies the appropriate HTTP method for a request to an HTTP EntryPoint. Values are capitalized strings as used in HTTP. |
iataCode
|
Airline or Airport | IATA identifier for an airline or airport. |
icaoCode
|
Airport | IACO identifier for an airport. |
inLanguage
|
CommunicateAction or CreativeWork or WriteAction or Event | The language of the content or performance or used in an action. Please use one of the language codes from the IETF BCP 47 standard. Supersedes language. |
incentiveCompensation
|
JobPosting | Description of bonus and commission compensation aspects of the job. Supersedes incentives. |
industry
|
JobPosting | The industry associated with the job position. |
ineligibleRegion
|
Demand or DeliveryChargeSpecification or Offer | The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.
See also eligibleRegion. |
intensity
|
ExercisePlan | Quantitative measure gauging the degree of force involved in the exercise, for example, heartbeats per minute. May include the velocity of the movement. |
interactivityType
|
CreativeWork | The predominant mode of learning supported by the learning resource. Acceptable values are 'active', 'expositive', or 'mixed'. |
isbn
|
Book | The ISBN of the book. |
isicV4
|
Person or Organization or Place | The International Standard of Industrial Classification of All Economic Activities (ISIC), Revision 4 code for a particular organization, business person, or place. |
isrcCode
|
MusicRecording | The International Standard Recording Code for the recording. |
issn
|
Periodical | The International Standard Serial Number (ISSN) that identifies this periodical. You can repeat this property to (for example) identify different formats of this periodical. |
issueNumber
|
PublicationIssue | Identifies the issue of publication; for example, "iii" or "2". |
iswcCode
|
MusicComposition | The International Standard Musical Work Code for the composition. |
itemListElement
|
ItemList | For itemListElement values, you can use simple strings (e.g. "Peter", "Paul", "Mary"), existing entities, or use ListItem.
Text values are best if the elements in the list are plain strings. Existing entities are best for a simple, unordered list of existing things in your data. ListItem is used with ordered lists when you want to provide additional context about the element in that list or when the same item might be in different places in different lists. Note: The order of elements in your mark-up is not sufficient for indicating the order or elements. Use ListItem with a 'position' property in such cases. |
itemListOrder
|
ItemList | Type of ordering (e.g. Ascending, Descending, Unordered). |
jobBenefits
|
JobPosting | Description of benefits associated with the job. Supersedes benefits. |
jobTitle
|
Person | The job title of the person (for example, Financial Manager). |
keywords
|
CreativeWork | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. |
knownVehicleDamages
|
Vehicle | A textual description of known damages, both repaired and unrepaired. |
latitude
|
GeoCoordinates | The latitude of a location. For example 37.42242 (WGS 84). |
learningResourceType
|
CreativeWork | The predominant type or kind characterizing the learning resource. For example, 'presentation', 'handout'. |
legalName
|
Organization | The official name of the organization, e.g. the registered company name. |
line
|
GeoShape | A line is a point-to-point path consisting of two or more points. A line is expressed as a series of two or more point objects separated by space. |
location
|
Organization or Action or Event | The location of for example where the event is happening, an organization is located, or where an action takes place. |
lodgingUnitDescription
|
LodgingReservation | A full description of the lodging unit. |
lodgingUnitType
|
LodgingReservation | Textual description of the unit type (including suite vs. room, size of bed, etc.). |
longitude
|
GeoCoordinates | The longitude of a location. For example -122.08585 (WGS 84). |
lowPrice
|
AggregateOffer | The lowest price of all offers available. |
mealService
|
Flight | Description of the meals that will be provided or available for purchase. |
membershipNumber
|
ProgramMembership | A unique identifier for the membership. |
memoryRequirements
|
SoftwareApplication | Minimum memory requirements. |
menu
|
FoodEstablishment | Either the actual menu or a URL of the menu. |
model
|
Product | The model of the product. Use with the URL of a ProductModel or a textual representation of the model identifier. The URL of the ProductModel can be from an external source. It is recommended to additionally provide strong product identifiers via the gtin8/gtin13/gtin14 and mpn properties. |
mpn
|
Demand or Product or Offer | The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
musicCompositionForm
|
MusicComposition | The type of composition (e.g. overture, sonata, symphony, etc.). |
musicalKey
|
MusicComposition | The key, mode, or scale this composition uses. |
naics
|
Person or Organization | The North American Industry Classification System (NAICS) code for a particular organization or business person. |
name
|
Thing | The name of the item. |
numberOfAirbags
|
Vehicle | The number or type of airbags in the vehicle. |
occupationalCategory
|
JobPosting | Category or categories describing the job. Use BLS O*NET-SOC taxonomy: http://www.onetcenter.org/taxonomy.html. Ideally includes textual label and formal code, with the property repeated for each applicable value. |
openingHours
|
CivicStructure or LocalBusiness | The opening hours for a business. Opening hours can be specified as a weekly time range, starting with days, then times per day. Multiple days can be listed with commas ',' separating each day. Day or time ranges are specified using a hyphen '-'. - Days are specified using the following two-letter combinations: Mo , Tu , We , Th , Fr , Sa , Su .- Times are specified using 24:00 time. For example, 3pm is specified as 15:00 . - Here is an example: <time itemprop="openingHours" datetime="Tu,Th 16:00-20:00">Tuesdays and Thursdays 4-8pm</time> . - If a business is open 7 days a week, then it can be specified as <time itemprop="openingHours" datetime="Mo-Su">Monday through Sunday, all day</time> . |
operatingSystem
|
SoftwareApplication | Operating systems supported (Windows 7, OSX 10.6, Android 1.6). |
orderItemNumber
|
OrderItem | The identifier of the order item. |
orderNumber
|
Order | The identifier of the transaction. |
pageEnd
|
Article or PublicationIssue or PublicationVolume | The page on which the work ends; for example "138" or "xvi". |
pageStart
|
Article or PublicationIssue or PublicationVolume | The page on which the work starts; for example "135" or "xiii". |
pagination
|
Article or PublicationIssue or PublicationVolume | Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55" or "10-12, 46-49". |
passengerPriorityStatus
|
FlightReservation | The priority status assigned to a passenger for security or boarding (e.g. FastTrack or Priority). |
passengerSequenceNumber
|
FlightReservation | The passenger's sequence number as assigned by the airline. |
paymentAccepted
|
LocalBusiness | Cash, credit card, etc. |
paymentMethodId
|
Order or Invoice | An identifier for the method of payment used (e.g. the last 4 digits of the credit card). |
paymentStatus
|
Invoice | The status of payment; whether the invoice has been paid or not. |
permissions
|
SoftwareApplication | Permission(s) required to run the app (for example, a mobile app may require full internet access or may run only on wifi). |
playerType
|
MediaObject | Player type required—for example, Flash or Silverlight. |
polygon
|
GeoShape | A polygon is the area enclosed by a point-to-point path for which the starting and ending points are the same. A polygon is expressed as a series of four or more space delimited points where the first and final points are identical. |
position
|
ListItem or CreativeWork | The position of an item in a series or sequence of items. |
postOfficeBoxNumber
|
PostalAddress | The post office box number for PO box addresses. |
postalCode
|
GeoCoordinates or PostalAddress or GeoShape | The postal code. For example, 94043. |
price
|
PriceSpecification or TradeAction or Offer | The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes.
Usage guidelines:
|
priceCurrency
|
Ticket or Reservation or PriceSpecification or Offer | The currency (in 3-letter ISO 4217 format) of the price or a price component, when attached to PriceSpecification and its subtypes. |
priceRange
|
LocalBusiness | The price range of the business, for example $$$ . |
priceType
|
UnitPriceSpecification | A short text or acronym indicating multiple price specifications for the same offer, e.g. SRP for the suggested retail price or INVOICE for the invoice price, mostly used in the car industry. |
printColumn
|
NewsArticle | The number of the column in which the NewsArticle appears in the print edition. |
printEdition
|
NewsArticle | The edition of the print product in which the NewsArticle appears. |
printPage
|
NewsArticle | If this NewsArticle appears in print, this field indicates the name of the page on which the article is found. Please note that this field is intended for the exact page name (e.g. A5, B18). |
printSection
|
NewsArticle | If this NewsArticle appears in print, this field indicates the print section in which the article appeared. |
processorRequirements
|
SoftwareApplication | Processor architecture required to run the application (e.g. IA64). |
productID
|
Product | The product identifier, such as ISBN. For example: <meta itemprop='productID' content='isbn:123-456-789'/> . |
productSupported
|
ContactPoint | The product or service this support contact point is related to (such as product support for a particular product line). This can be a specific product or product line (e.g. "iPhone") or a general category of products or services (e.g. "smartphones"). |
proficiencyLevel
|
TechArticle | Proficiency needed for this content; expected values: 'Beginner', 'Expert'. |
programName
|
ProgramMembership | The program providing the membership. |
programmingModel
|
APIReference | Indicates whether API is managed or unmanaged. |
propertyID
|
PropertyValue | A commonly used identifier for the characteristic represented by the property, e.g. a manufacturer or a standard code for a property. propertyID can be (1) a prefixed string, mainly meant to be used with standards for product properties; (2) a site-specific, non-prefixed string (e.g. the primary key of the property or the vendor-specific id of the property), or (3) a URL indicating the type of the property, either pointing to an external vocabulary, or a Web resource that describes the property (e.g. a glossary entry). Standards bodies should promote a standard prefix for the identifiers of properties from their standards. |
providerMobility
|
Service | Indicates the mobility of a provided service (e.g. 'static', 'dynamic'). |
qualifications
|
JobPosting | Specific qualifications required for this role. |
query
|
SearchAction | A sub property of instrument. The query used on this action. |
ratingValue
|
Rating | The rating for the content. |
recipeCategory
|
Recipe | The category of the recipe—for example, appetizer, entree, etc. |
recipeCuisine
|
Recipe | The cuisine of the recipe (for example, French or Ethiopian). |
recipeIngredient
|
Recipe | A single ingredient used in the recipe, e.g. sugar, flour or garlic. |
recipeInstructions
|
Recipe | A step or instruction involved in making the recipe. |
recipeYield
|
Recipe | The quantity produced by the recipe (for example, number of people served, number of servings, etc). |
releaseNotes
|
SoftwareApplication | Description of what changed in this version. |
reportNumber
|
Report | The number or other unique designator assigned to a Report by the publishing organization. |
requiredGender
|
PeopleAudience | Audiences defined by a person's gender. |
reservationId
|
Reservation | A unique identifier for the reservation. |
responsibilities
|
JobPosting | Responsibilities associated with this role. |
restPeriods
|
ExercisePlan | How often one should break from the activity. |
reviewBody
|
Review | The actual body of the review. |
roleName
|
Role | A role played, performed or filled by a person or organization. For example, the team of creators for a comic book might fill the roles named 'inker', 'penciller', and 'letterer'; or an athlete in a SportsTeam might play in the position named 'Quarterback'. Supersedes namedPosition. |
runtimePlatform
|
SoftwareSourceCode | Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0). Supersedes runtime. |
salaryCurrency
|
EmployeeRole or JobPosting | The currency (coded using ISO 4217, http://en.wikipedia.org/wiki/ISO_4217 ) used for the main salary information in this job posting or for this employee. |
schemaVersion
|
CreativeWork | Indicates (by URL or string) a particular version of a schema used in some CreativeWork. For example, a document could declare a schemaVersion using an URL such as http://schema.org/version/2.0/ if precise indication of schema version was required by some application. |
seasonNumber
|
CreativeWorkSeason | Position of the season within an ordered group of seasons. |
seatNumber
|
Seat | The location of the reserved seat (e.g., 27). |
seatRow
|
Seat | The row location of the reserved seat (e.g., B). |
seatSection
|
Seat | The section location of the reserved seat (e.g. Orchestra). |
seatingType
|
Seat | The type/class of the seat. |
securityScreening
|
FlightReservation | The type of security screening the passenger is subject to. |
serialNumber
|
Demand or IndividualProduct or Offer | The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer. |
servesCuisine
|
FoodEstablishment | The cuisine of the restaurant. |
serviceType
|
Service | The type of service being offered, e.g. veterans' benefits, emergency relief, etc. |
servingSize
|
NutritionInformation | The serving size, in terms of the number of volume or mass. |
skills
|
JobPosting | Skills required to fulfill this role. |
sku
|
Demand or Product or Offer | The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. |
softwareRequirements
|
SoftwareApplication | Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (Examples: DirectX, Java or .NET runtime). Supersedes requirements. |
softwareVersion
|
SoftwareApplication | Version of the software instance. |
specialCommitments
|
JobPosting | Any special commitments associated with this job posting. Valid entries include VeteranCommit, MilitarySpouseCommit, etc. |
sport
|
SportsOrganization | A type of sport (e.g. Baseball). |
storageRequirements
|
SoftwareApplication | Storage requirements (free space required). |
streetAddress
|
PostalAddress | The street address. For example, 1600 Amphitheatre Pkwy. |
subtitleLanguage
|
ScreeningEvent or TVEpisode or Movie | Languages in which subtitles/captions are available, in IETF BCP 47 standard format. |
suggestedGender
|
PeopleAudience | The gender of the person or audience. |
targetDescription
|
AlignmentObject | The description of a node in an established educational framework. |
targetName
|
AlignmentObject | The name of a node in an established educational framework. |
targetPlatform
|
APIReference | Type of app development: phone, Metro style, desktop, XBox, etc. |
taxID
|
Person or Organization | The Tax / Fiscal ID of the organization or person, e.g. the TIN in the US or the CIF/NIF in Spain. |
telephone
|
Person or Organization or ContactPoint or Place | The telephone number. |
text
|
CreativeWork | The textual content of this CreativeWork. |
tickerSymbol
|
Corporation | The exchange traded instrument associated with a Corporation object. The tickerSymbol is expressed as an exchange and an instrument name separated by a space character. For the exchange component of the tickerSymbol attribute, we reccommend using the controlled vocaulary of Market Identifier Codes (MIC) specified in ISO15022. |
ticketNumber
|
Ticket | The unique identifier for the ticket. |
ticketToken
|
Ticket | Reference to an asset (e.g., Barcode, QR code image or PDF) usable for entrance. |
title
|
JobPosting | The title of the job. |
totalPrice
|
Ticket or Reservation | The total price for the reservation or ticket, including applicable taxes, shipping, etc. |
trackingNumber
|
ParcelDelivery | Shipper tracking number. |
trainName
|
TrainTrip | The name of the train (e.g. The Orient Express). |
trainNumber
|
TrainTrip | The unique identifier for the train. |
transcript
|
AudioObject or VideoObject | If this MediaObject is an AudioObject or VideoObject, the transcript of that object. |
typicalAgeRange
|
CreativeWork or Event | The typical expected age range, e.g. '7-9', '11-'. |
unitCode
|
QuantitativeValue or TypeAndQuantityNode or PropertyValue or UnitPriceSpecification | The unit of measurement given using the UN/CEFACT Common Code (3 characters) or a URL. Other codes than the UN/CEFACT Common Code may be used with a prefix followed by a colon. |
unitText
|
QuantitativeValue or TypeAndQuantityNode or PropertyValue or UnitPriceSpecification | A string or text indicating the unit of measurement. Useful if you cannot provide a standard unit code for unitCode. |
urlTemplate
|
EntryPoint | An url template (RFC6570) that will be used to construct the target of the execution of the action. |
value
|
QuantitativeValue or PropertyValue | The value of the quantitative value or property value node. For QuantitativeValue, the recommended type for values is 'Number'. For PropertyValue, it can be 'Text;', 'Number', 'Boolean', or 'StructuredValue'. |
valueName
|
PropertyValueSpecification | Indicates the name of the PropertyValueSpecification to be used in URL templates and form encoding in a manner analogous to HTML's input@name. |
valuePattern
|
PropertyValueSpecification | Specifies a regular expression for testing literal values according to the HTML spec. |
vatID
|
Person or Organization | The Value-added Tax ID of the organization or person. |
vehicleConfiguration
|
Vehicle | A short text indicating the configuration of the vehicle, e.g. '5dr hatchback ST 2.5 MT 225 hp' or 'limited edition'. |
vehicleIdentificationNumber
|
Vehicle | The Vehicle Identification Number (VIN) is a unique serial number used by the automotive industry to identify individual motor vehicles. |
vehicleInteriorColor
|
Vehicle | The color or color combination of the interior of the vehicle. |
vehicleInteriorType
|
Vehicle | The type or material of the interior of the vehicle (e.g. synthetic fabric, leather, wood, etc.). While most interior types are characterized by the material used, an interior type can also be based on vehicle usage or target audience. |
vehicleSpecialUsage
|
Vehicle | Indicates whether the vehicle has been used for special purposes, like commercial rental, driving school, or as a taxi. The legislation in many countries requires this information to be revealed when offering a car for sale. |
vehicleTransmission
|
Vehicle | The type of component used for transmitting the power from a rotating power source to the wheels or other relevant component(s) ("gearbox" for cars). |
videoFormat
|
ScreeningEvent or TelevisionStation | The type of screening or video broadcast used (e.g. IMAX, 3D, SD, HD, etc.). |
videoFrameSize
|
VideoObject | The frame size of the video. |
videoQuality
|
VideoObject | The quality of the video. |
volumeNumber
|
PublicationVolume | Identifies the volume of publication or multi-part work; for example, "iii" or "2". |
workHours
|
JobPosting | The typical working hours for this job (e.g. 1st shift, night shift, 8am-5pm). |
worstRating
|
Rating | The lowest value allowed in this rating system. If worstRating is omitted, 1 is assumed. |
More specific DataTypes
Schema Version 2.2