extension shown: fhir [x]


Defined in the fhir.schema.org extension.
Canonical URL: http://schema.org/Conformance

Thing > Resource > DomainResource > Conformance
conformance.behavior > Conformance

Base StructureDefinition for Conformance Resource

Usage: Fewer than 10 domains
PropertyExpected TypeDescription
Properties from Conformance
Conformance.acceptUnknown unknown-content-code A code that indicates whether the application accepts unknown elements or extensions when reading resources.
Conformance.contact BackboneElement Contacts to assist a user in finding and communicating with the publisher.
Conformance.contact.name Text The name of an individual to contact regarding the conformance.
Conformance.contact.telecom ContactPoint Contact details for individual (if a name was provided) or the publisher.
Conformance.copyright Text 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.date DateTime The date (and optionally time) when the conformance statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the conformance statement changes.
Conformance.description Text 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 BackboneElement A document definition.
Conformance.document.documentation Text 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.document.mode document-mode Mode of this document declaration - whether application is producer or consumer.
Conformance.document.profile StructureDefinition A constraint on a resource used in the document.
Conformance.experimental Boolean A flag to indicate that this conformance statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
Conformance.fhirVersion Text The version of the FHIR specification on which this conformance statement is based.
Conformance.format http://www.rfc-editor.org/bcp/bcp13.txt A list of the formats supported by this implementation using their content types.
Conformance.implementation BackboneElement Identifies a specific implementation instance that is described by the conformance statement - i.e. a particular installation, rather than the capabilities of a software program.
Conformance.implementation.description Text Information about the specific installation that this conformance statement relates to.
Conformance.implementation.url Text An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
Conformance.kind conformance-statement-kind The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
Conformance.messaging BackboneElement A description of the messaging capabilities of the solution.
Conformance.messaging.documentation Text 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 BackboneElement An endpoint (network accessible address) to which messages and/or replies are to be sent.
Conformance.messaging.endpoint.address Text 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.endpoint.protocol Coding A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
Conformance.messaging.event BackboneElement A description of the solution's support for an event at this end-point.
Conformance.messaging.event.category message-significance-category The impact of the content of the message.
Conformance.messaging.event.code Coding A coded identifier of a supported messaging event.
Conformance.messaging.event.documentation Text Guidance on how this event is handled, such as internal system trigger points, business rules, etc.
Conformance.messaging.event.focus resource-types A resource associated with the event. This is the resource that defines the event.
Conformance.messaging.event.mode message-conformance-event-mode The mode of this event declaration - whether application is sender or receiver.
Conformance.messaging.event.request StructureDefinition Information about the request for this event.
Conformance.messaging.event.response StructureDefinition Information about the response for this event.
Conformance.messaging.reliableCache unsignedInt Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
Conformance.name Text A free text natural language name identifying the conformance statement.
Conformance.profile StructureDefinition A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles]{profiling.html#profile-uses}.
Conformance.publisher Text The name of the individual or organization that published the conformance.
Conformance.requirements Text Explains why this conformance statement is needed and why it's been constrained as it has.
Conformance.rest BackboneElement A definition of the restful capabilities of the solution, if any.
Conformance.rest.compartment Text An absolute URI which is a reference to the definition of a compartment hosted by the system.
Conformance.rest.documentation Text Information about the system's restful capabilities that apply across all applications, such as security.
Conformance.rest.interaction BackboneElement A specification of restful operations supported by the system.
Conformance.rest.interaction.code system-restful-interaction A coded identifier of the operation, supported by the system.
Conformance.rest.interaction.documentation Text 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.mode restful-conformance-mode Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.
Conformance.rest.operation BackboneElement Definition of an operation or a named query and with its parameters and their meaning and type.
Conformance.rest.operation.definition OperationDefinition Where the formal definition can be found.
Conformance.rest.operation.name Text The name of a query, which is used in the _query parameter when the query is called.
Conformance.rest.resource BackboneElement A specification of the restful capabilities of the solution for a specific resource type.
Conformance.rest.resource.conditionalCreate Boolean A flag that indicates that the server supports conditional create.
Conformance.rest.resource.conditionalDelete conditional-delete-status A code that indicates how the server supports conditional delete.
Conformance.rest.resource.conditionalUpdate Boolean A flag that indicates that the server supports conditional update.
Conformance.rest.resource.interaction BackboneElement Identifies a restful operation supported by the solution.
Conformance.rest.resource.interaction.code type-restful-interaction Coded identifier of the operation, supported by the system resource.
Conformance.rest.resource.interaction.documentation Text 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.profile StructureDefinition A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}.
Conformance.rest.resource.readHistory Boolean A flag for whether the server is able to return past versions as part of the vRead operation.
Conformance.rest.resource.searchInclude Text A list of _include values supported by the server.
Conformance.rest.resource.searchParam BackboneElement Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
Conformance.rest.resource.searchParam.chain Text 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 Text 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 Text This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
Conformance.rest.resource.searchParam.modifier search-modifier-code A modifier supported for the search parameter.
Conformance.rest.resource.searchParam.name Text The name of the search parameter used in the interface.
Conformance.rest.resource.searchParam.target resource-types Types of resource (if a resource is referenced).
Conformance.rest.resource.searchParam.type search-param-type The type of value a search parameter refers to, and how the content is interpreted.
Conformance.rest.resource.searchRevInclude Text A list of _revinclude (reverse include) values supported by the server.
Conformance.rest.resource.type resource-types A type of resource exposed via the restful interface.
Conformance.rest.resource.updateCreate Boolean A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
Conformance.rest.resource.versioning versioning-policy This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
Conformance.rest.security BackboneElement Information about security implementation from an interface perspective - what a client needs to know.
Conformance.rest.security.certificate BackboneElement Certificates associated with security profiles.
Conformance.rest.security.certificate.blob base64Binary Actual certificate.
Conformance.rest.security.certificate.type http://www.rfc-editor.org/bcp/bcp13.txt Mime type for certificate.
Conformance.rest.security.cors Boolean Server adds CORS headers when responding to requests - this enables javascript applications to use the server.
Conformance.rest.security.description Text General description of how security works.
Conformance.rest.security.service restful-security-service Types of security services are supported/required by the system.
Conformance.rest.transactionMode transaction-mode A code that indicates how transactions are supported.
Conformance.software BackboneElement Software that is covered by this conformance statement. It is used when the conformance statement describes the capabilities of a particular software version, independent of an installation.
Conformance.software.name Text Name software is known by.
Conformance.software.releaseDate DateTime Date this version of the software released.
Conformance.software.version Text The version identifier for the software covered by this statement.
Conformance.status conformance-resource-status The status of this conformance statement.
Conformance.url Text 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 Text 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.
Properties from DomainResource
DomainResource.contained Resource These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
DomainResource.extension Extension May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
DomainResource.modifierExtension Extension May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
DomainResource.text Narrative A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Properties from Resource
Resource.id Text The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Resource.implicitRules Text A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Resource.language http://tools.ietf.org/html/bcp47 The base language in which the resource is written.
Resource.meta Meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Properties from Thing
additionalType URL An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.
alternateName Text An alias for the item.
description Text A description of the item.
disambiguatingDescription Text 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.
image URL  or
An image of the item. This can be a URL or a fully described ImageObject.
mainEntityOfPage CreativeWork  or
Indicates a page (or other CreativeWork) for which this thing is the main entity being described.

See background notes for details.
Inverse property: mainEntity.
name Text The name of the item.
potentialAction Action Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.
sameAs URL URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.
url URL URL of the item.

Instances of Conformance may appear as values for the following properties
PropertyOn TypesDescription
TestScript.metadata.capability.conformance TestScript Minimum conformance required of server for test script to execute successfully. If server does not meet at a minimum the reference conformance definition, then all tests in this script are skipped.

Available supertypes defined in extensions

Schema Version 2.2