Expansionprofile.shex

ShEx statement for expansionprofile

PREFIX fhir: <http://hl7.org/fhir/> 
PREFIX fhirvs: <http://hl7.org/fhir/ValueSet/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#> 
BASE <http://hl7.org/fhir/shape/>

start=<ExpansionProfile> AND {fhir:nodeRole [fhir:treeRoot]}


# Defines behaviour and contraints on the ValueSet Expansion operation
<ExpansionProfile> CLOSED {
    a [fhir:ExpansionProfile];
    fhir:nodeRole [fhir:treeRoot]?;
    fhir:Resource.id @<id>?;                # Logical id of this artifact
    fhir:Resource.meta @<Meta>?;            # Metadata about the resource
    fhir:Resource.implicitRules @<uri>?;    # A set of rules under which this 
                                            # content was created 
    fhir:Resource.language @<code>?;        # Language of the resource content
    fhir:DomainResource.text @<Narrative>?;  # Text summary of the resource, for 
                                            # human interpretation 
    fhir:DomainResource.contained @<Resource>*;  # Contained, inline Resources
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.url @<uri>?;      # Globally unique logical identifier 
                                            # for  expansion profile 
    fhir:ExpansionProfile.identifier @<Identifier>?;  # Additional identifier for the 
                                            # expansion profile (e.g. an Object 
                                            # Identifier) 
    fhir:ExpansionProfile.version @<string>?;  # Logical identifier for this 
                                            # version of the expansion profile 
    fhir:ExpansionProfile.name @<string>?;  # Informal name for this expansion 
                                            # profile 
    fhir:ExpansionProfile.status @<code> AND
    	{fhir:value @fhirvs:conformance-resource-status};  # draft | active | retired
    fhir:ExpansionProfile.experimental @<boolean>?;  # If for testing purposes, not real 
                                            # usage 
    fhir:ExpansionProfile.publisher @<string>?;  # Name of the publisher 
                                            # (organization or individual) 
    fhir:ExpansionProfile.contact @<ExpansionProfile.contact>*;  # Contact details of the publisher
    fhir:ExpansionProfile.date @<dateTime>?;  # Date for given status
    fhir:ExpansionProfile.description @<markdown>?;  # Human language description of the 
                                            # expansion profile 
    fhir:ExpansionProfile.codeSystem @<ExpansionProfile.codeSystem>?;  # When the expansion profile imposes 
                                            # code system contraints 
    fhir:ExpansionProfile.includeDesignations @<boolean>?;  # Whether the expansion should 
                                            # include concept designations 
    fhir:ExpansionProfile.designation @<ExpansionProfile.designation>?;  # When the expansion profile imposes 
                                            # designation contraints 
    fhir:ExpansionProfile.includeDefinition @<boolean>?;  # Include or exclude the value set 
                                            # definition in the expansion 
    fhir:ExpansionProfile.includeInactive @<boolean>?;  # Include or exclude inactive 
                                            # concepts in the expansion 
    fhir:ExpansionProfile.excludeNested @<boolean>?;  # Include or exclude nested codes in 
                                            # the value set expansion 
    fhir:ExpansionProfile.excludeNotForUI @<boolean>?;  # Include or exclude codes which 
                                            # cannot be rendered in user 
                                            # interfaces in the value set 
                                            # expansion 
    fhir:ExpansionProfile.excludePostCoordinated @<boolean>?;  # Include or exclude codes which are 
                                            # post coordinated expressions in 
                                            # the value set expansion 
    fhir:ExpansionProfile.displayLanguage @<code>?;  # Specify the language for the 
                                            # display element of codes in the 
                                            # value set expansion 
    fhir:ExpansionProfile.limitedExpansion @<boolean>?;  # Controls behaviour of the value 
                                            # set expand operation when value 
                                            # sets are too large to be 
                                            # completely expanded 
    fhir:index xsd:integer?                 # Relative position in a list
}

# When the expansion profile imposes designation contraints
<ExpansionProfile.designation> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.designation.include @<ExpansionProfile.designation.include>?;  # Designations to be included
    fhir:ExpansionProfile.designation.exclude @<ExpansionProfile.designation.exclude>?;  # Designations to be excluded
    fhir:index xsd:integer?                 # Relative position in a list
}

# When the expansion profile imposes code system contraints
<ExpansionProfile.codeSystem> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.codeSystem.include @<ExpansionProfile.codeSystem.include>?;  # Code systems to be included
    fhir:ExpansionProfile.codeSystem.exclude @<ExpansionProfile.codeSystem.exclude>?;  # Code systems to be excluded
    fhir:index xsd:integer?                 # Relative position in a list
}

# Contact details of the publisher
<ExpansionProfile.contact> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.contact.name @<string>?;  # Name of an individual to contact
    fhir:ExpansionProfile.contact.telecom @<ContactPoint>*;  # Contact details for individual or 
                                            # publisher 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Designations to be included
<ExpansionProfile.designation.include> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.designation.include.designation @<ExpansionProfile.designation.include.designation>*;  # The designation to be included
    fhir:index xsd:integer?                 # Relative position in a list
}

# Code systems to be included
<ExpansionProfile.codeSystem.include> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.codeSystem.include.codeSystem @<ExpansionProfile.codeSystem.include.codeSystem>+;  # The code systems to be included
    fhir:index xsd:integer?                 # Relative position in a list
}

# Code systems to be excluded
<ExpansionProfile.codeSystem.exclude> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.codeSystem.exclude.codeSystem @<ExpansionProfile.codeSystem.exclude.codeSystem>+;  # The code systems to be excluded
    fhir:index xsd:integer?                 # Relative position in a list
}

# Designations to be excluded
<ExpansionProfile.designation.exclude> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.designation.exclude.designation @<ExpansionProfile.designation.exclude.designation>*;  # The designation to be excluded
    fhir:index xsd:integer?                 # Relative position in a list
}

# The code systems to be included
<ExpansionProfile.codeSystem.include.codeSystem> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.codeSystem.include.codeSystem.system @<uri>;  # The specific code system to be 
                                            # included 
    fhir:ExpansionProfile.codeSystem.include.codeSystem.version @<string>?;  # Specific version of the code 
                                            # system referred to 
    fhir:index xsd:integer?                 # Relative position in a list
}

# The code systems to be excluded
<ExpansionProfile.codeSystem.exclude.codeSystem> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.codeSystem.exclude.codeSystem.system @<uri>;  # The specific code system to be 
                                            # excluded 
    fhir:ExpansionProfile.codeSystem.exclude.codeSystem.version @<string>?;  # Specific version of the code 
                                            # system referred to 
    fhir:index xsd:integer?                 # Relative position in a list
}

# The designation to be excluded
<ExpansionProfile.designation.exclude.designation> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.designation.exclude.designation.language @<code>?;  # Human language of the designation 
                                            # to be excluded 
    fhir:ExpansionProfile.designation.exclude.designation.use @<Coding> AND
    	{fhir:value @fhirvs:designation-use}?;  # Designation use
    fhir:index xsd:integer?                 # Relative position in a list
}

# The designation to be included
<ExpansionProfile.designation.include.designation> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:modifierExtension @<Extension>*;   # Extensions that cannot be ignored
    fhir:ExpansionProfile.designation.include.designation.language @<code>?;  # Human language of the designation 
                                            # to be included 
    fhir:ExpansionProfile.designation.include.designation.use @<Coding> AND
    	{fhir:value @fhirvs:designation-use}?;  # Designation use
    fhir:index xsd:integer?                 # Relative position in a list
}

#---------------------- Data Types -------------------

# Primitive Type dateTime
<dateTime> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:gYear OR xsd:gYearMonth OR xsd:date OR xsd:dateTime?;  # Primitive value for dateTime
    fhir:index xsd:integer?                 # Relative position in a list
}

# Metadata about a resource
<Meta> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:Meta.versionId @<id>?;             # Version specific identifier
    fhir:Meta.lastUpdated @<instant>?;      # When the resource version last 
                                            # changed 
    fhir:Meta.profile @<uri>*;              # Profiles this resource claims to 
                                            # conform to 
    fhir:Meta.security @<Coding>*;          # Security Labels applied to this 
                                            # resource 
    fhir:Meta.tag @<Coding>*;               # Tags applied to this resource
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type code
<code> CLOSED {
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string?;                 # Primitive value for code
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type string
<string> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string MAXLENGTH 1048576?;  # Primitive value for string
    fhir:index xsd:integer?                 # Relative position in a list
}

# Base Resource
<Resource> {a .+;
    fhir:Resource.id @<id>?;                # Logical id of this artifact
    fhir:Resource.meta @<Meta>?;            # Metadata about the resource
    fhir:Resource.implicitRules @<uri>?;    # A set of rules under which this 
                                            # content was created 
    fhir:Resource.language @<code>?;        # Language of the resource content
    fhir:index xsd:integer?
}

# Primitive Type uri
<uri> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string?;                 # Primitive value for uri
    fhir:index xsd:integer?                 # Relative position in a list
}

<Extension> {fhir:extension @<Extension>*;
    fhir:index xsd:integer?
}

# Details of a Technology mediated contact point (phone, fax, email, etc.)
<ContactPoint> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:ContactPoint.system @<code> AND
    	{fhir:value @fhirvs:contact-point-system}?;  # phone | fax | email | pager | other
    fhir:ContactPoint.value @<string>?;     # The actual contact point details
    fhir:ContactPoint.use @<code> AND
    	{fhir:value @fhirvs:contact-point-use}?;  # home | work | temp | old | mobile 
                                            # - purpose of this contact point 
    fhir:ContactPoint.rank @<positiveInt>?;  # Specify preferred order of use (1 
                                            # = highest) 
    fhir:ContactPoint.period @<Period>?;    # Time period when the contact point 
                                            # was/is in use 
    fhir:index xsd:integer?                 # Relative position in a list
}

# An identifier intended for computation
<Identifier> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:Identifier.use @<code> AND
    	{fhir:value @fhirvs:identifier-use}?;  # usual | official | temp | 
                                            # secondary (If known) 
    fhir:Identifier.type @<CodeableConcept>?;  # Description of identifier
    fhir:Identifier.system @<uri>?;         # The namespace for the identifier
    fhir:Identifier.value @<string>?;       # The value that is unique
    fhir:Identifier.period @<Period>?;      # Time period when id is/was valid 
                                            # for use 
    fhir:Identifier.assigner @<OrganizationReference>?;  # Organization that issued id (may 
                                            # be just text) 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type boolean
<boolean> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:boolean?;                # Primitive value for boolean
    fhir:index xsd:integer?                 # Relative position in a list
}

# A human-readable formatted text, including images
<Narrative> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:Narrative.status @<code> AND
    	{fhir:value @fhirvs:narrative-status};  # generated | extensions | 
                                            # additional | empty 
    fhir:Narrative.div xsd:string;          # Limited xhtml content
    fhir:index xsd:integer?                 # Relative position in a list
}

# A reference to a code defined by a terminology system
<Coding> CLOSED {
    fhir:concept IRI?;
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:Coding.system @<uri>?;             # Identity of the terminology system
    fhir:Coding.version @<string>?;         # Version of the system - if relevant
    fhir:Coding.code @<code>?;              # Symbol in syntax defined by the 
                                            # system 
    fhir:Coding.display @<string>?;         # Representation defined by the 
                                            # system 
    fhir:Coding.userSelected @<boolean>?;   # If this coding was chosen directly 
                                            # by the user 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type markdown
<markdown> CLOSED {
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string?;                 # Primitive value for markdown
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type id
<id> CLOSED {
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:string?;                 # Primitive value for id
    fhir:index xsd:integer?                 # Relative position in a list
}

# Time range defined by start and end date/time
<Period> CLOSED {
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:Period.start @<dateTime>?;         # Starting time with inclusive 
                                            # boundary 
    fhir:Period.end @<dateTime>?;           # End time with inclusive boundary, 
                                            # if not ongoing 
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type instant
<instant> CLOSED {
    fhir:id @<id>?;                         # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:dateTime?;               # Primitive value for instant
    fhir:index xsd:integer?                 # Relative position in a list
}

# Primitive Type positiveInt
<positiveInt> CLOSED {
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:value xsd:positiveInteger?;        # Primitive value for positiveInt
    fhir:index xsd:integer?                 # Relative position in a list
}

# Concept - reference to a terminology or just  text
<CodeableConcept> CLOSED {
    fhir:concept IRI*;
    fhir:Element.id @<string>?;             # xml:id (or equivalent in JSON)
    fhir:extension @<Extension>*;           # Additional Content defined by 
                                            # implementations 
    fhir:CodeableConcept.coding @<Coding>*;  # Code defined by a terminology 
                                            # system 
    fhir:CodeableConcept.text @<string>?;   # Plain text representation of the 
                                            # concept 
    fhir:index xsd:integer?                 # Relative position in a list
}

#---------------------- Reference Types -------------------

<OrganizationReference> CLOSED {
    fhir:Element.id @<id>?;
    fhir:extension @<Extension>*;
    fhir:link @<Organization> OR CLOSED {a fhir:Organization}?;
    fhir:Reference.reference @<string>?;
    fhir:Reference.display @<string>?;
    fhir:index xsd:integer?
}

#---------------------- Value Sets ------------------------

# The lifecycle status of a Value Set or Concept Map.
@fhirvs:conformance-resource-status = ["draft" "active" "retired"]

# Details of how a designation would be used
@fhirvs:designation-use = ["900000000000003001" "900000000000013009" "900000000000550004"]

# Use of contact point
@fhirvs:contact-point-use = ["home" "work" "temp" "old" "mobile"]

# Telecommunications form for contact point
@fhirvs:contact-point-system = ["phone" "fax" "email" "pager" "other"]

# The status of a resource narrative
@fhirvs:narrative-status = ["generated" "extensions" "additional" "empty"]

# Identifies the purpose for this identifier, if known .
@fhirvs:identifier-use = ["usual" "official" "temp" "secondary"]